Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document @title on @class=example #356

Closed
azaroth42 opened this issue Nov 3, 2014 · 3 comments
Closed

Document @title on @class=example #356

azaroth42 opened this issue Nov 3, 2014 · 3 comments

Comments

@azaroth42
Copy link

Not sure if this belongs here, but it would be great if the use of a title attribute on a section with class="example" to generate a title could be documented.

For example here: http://www.w3.org/respec/guide.html#examples-syntax-highlighting

@halindrome
Copy link
Contributor

According to the code, if you have an 'example' then a div is created with the class 'example-title'. That div will contain a 'span' with the text "Example N" where N is the example number that is automatically generated. If there is a title attribute on the element, then a colon and the text of the title attribute are appended to the contents of the span. E.g., <pre class='example' title='My Important Example'>some example</pre> will be prepended with <div class='example-title'><span>Example N</span>: My Important Example</div>

Is that the behavior you are seeing? And is that what you would like documented?

@azaroth42
Copy link
Author

Yes, that's exactly what I'm seeing, expecting and would like to be documented in the reference and/or user guide :)

@halindrome
Copy link
Contributor

This issue was moved to w3c/respec-docs#17

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants