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
index entries for library declarations should point at the declaration itself, not the start of the synopsis #1562
Comments
For [string], we seem to create the index entries with the |
@zygoloid: Do you think this is editorial cleanup that could / should be applied post-DIS, but pre-publication of C++17? |
IIRC, the reason I did not do this in my last indexing spree is that I don't know LaTeX well enough to handle all the un-escaping in an appropriate macro. My memory is that placing the index macro above the declarations in the synopsis created duplicate entries in the index. We get a similar problem with the container requirements and type traits tables, that actually provide the majority of the definitions for those clauses. |
@zygoloid: What exactly is the desired approach here? Put index entries next to the \itemdecl details (where \itemdecl is used at all), and for the remaining functions, implement your \libdecl suggestion to put index markers in the synopsis? Or annotate the synopsis only? |
Editorial meeting consensus: Index \itemdecl where they exist, and limit indexing of synopses to names only appearing there. Index entries for synopsis items should be inline. Add a special LaTeX macro (e.g. \libdecl) that adds the text to a code block and adds an index entry. |
I guess if we switch from makeindex to xindy (an option explored in #1917), its capabilities might help here, too. For cxxdraft-htmlgen, having library index entries point to the actual declarations of the entities would be fantastic, because really, it's what people expect on a hyperlinked web page. :) |
This is particularly obvious for very long synopses. We generally write index entries at the start of the synopsis block, but we should really be pointing them at the point within the synopsis where the indexed entity is declared.
We probably need a new macro for marking up a library entity in a synopsis that adds an index entry and emits the name of that entity, so we can write something like:
to emit and index the name (with another form for member functions).
The text was updated successfully, but these errors were encountered: