add docs for noLegacyStyle flag #238
Conversation
|
@anssiko np. It appears the build is failing? |
| @@ -475,6 +475,11 @@ | |||
| If this document is of a status that usually goes with Rec Track, but isn't intended for it, | |||
| set this to true. | |||
| </dd> | |||
| <dt>noLegacyStyle</dt> | |||
| <dd> | |||
| if set, removes legacy DOM-style sections (Attributes etc.) following WebIDL blocks. This | |||
There was a problem hiding this comment.
You should probably say that it's a boolean?
add docs for noLegacyStyle flag
|
Thanks for the docs! I reckon people can figure out it's boolean. This isn't what was failing the build (Travis is weird sometimes). |
|
I've added a note in the wiki to expand this documentation. It's good to give justification as to why not using the legacy style is a good thing. |
|
It's not clear to me how, once enabled, the markup is supposed to be changed. I can see a lot of content gets removed from a spec once this is enabled. Can you provide some details as to how then a spec is supposed to be edited or point to a spec that was edited using this style? |
|
(please reopen this bug :) ) |
|
FWIW, I'm trying to migrate http://telephony.sysapps.org/ right now, and could really use some guidance. |
|
@marcoscaceres, you can look at the Battery Status API as an example: https://dvcs.w3.org/hg/dap/raw-file/default/battery/Overview.html Basically you'll just need to move the prose from Attributes and Methods sections and put it below the IDL markup definition. In practice, you may need to adapt the language a bit and link the IDL members back to the prose (ReSpec automatically generates fragment identifiers that start with "#widl-", just add corresponding ids to appropriate parts in the prose and you're done). Let me know if you run into any issues. |
|
Thanks @anssiko! really appreciate the pointers and guidance! |
@marcoscaceres thanks for reminding me of missing docs. This should address #237.