-
Notifications
You must be signed in to change notification settings - Fork 46
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
Formatting of local links in text; Lists of Figures, Tables and Examples #499
Comments
Dear @larsbarring Thanks a lot for this careful investigation. I certainly agree that these defects should be fixed, and also that the list of figures would more useful if it contained the fig titles too. Perhaps like you, I find the asciidoc syntax rather opaque when it gets beyond obvious text formatting. Best wishes Jonathan |
I have prepared PR #565 that I think corrects all of these defects. I believe that all of these changes are purely editorial and do not change the meaning or interpretation of the text. Here is the HTML (gzipped) with the changes: @larsbarring or @JonathanGregory - could you have a glance over this, perhaps? Many thanks, |
@davidhassell if that 1px image is no longer necessary, usual git practice would be to delete it and retrieve it from the git history if it ever needs to be used again. |
Hi @DocOtak - sure thing. It has been deleted. I thought the comment on the procedure was potentially useful to retain but no one's going to find it there, so I'll delete that too :) |
Dear @davidhassell Thanks for this great effort! In looking through the PR, I've noted three places where perhaps we could have just Since you're on a roll, please could you also correct the first two entries in the Table of Figures, which currently appear like this?
Best wishes Jonathan |
@davidhassell I meant the file of the image, the comment is useful and probably should stay so we know what to do when a long table title happens. |
Oh, I see :) I'll delete the file and re-instate the comment. |
Dear Jonathan, I have fixed up the chapter 7 figure references (25f355e). Ideally all of the figures in the list of contents would have descriptive titles (like the tables), rather than just (e.g.) "Figure 8.1". This could be done but, as far as can ascertain, we'd have to hard-wire the figure numbers when used in references in the main body of the text (so that the reference rendered as "Figure 8.1", as opposed to "<Long description of figure>". This is probably not a great problem, as that's have we do example and table references, but I suppose it's a shame to break the auto-numbering we enjoy with figures. |
New rendering: cf-conventions.html.gz |
I've decided to keep the image file after all - if we want to do this technique in the future, we're going to not want the bother of creating a new file. I've updated the comment to say that there's a file that can be used: 11d5deb |
Thanks, David. It's a shame that asciidoc isn't as clever as |
I asked a question about that over at the asciidoc support forum. |
Thanks for finding the answer, Lars. We must try to remember about that, since this issue will be closed. If no-one objects to any of these defects being fixed, the PR will be merged next Wednesday 4th, just in time for David to build CF 1.12. |
Formatting of local links in text; Lists of Figures, Tables and Examples
Moderator
not yet
Requirement Summary
Currently there are some formatting deficiences in local links that affects the Lists of Tables, Figures, and Examples. These need to be fixed and preferably harmonised so that the three Lists have a similar style.
Technical Proposal Summary
Benefits
Readers will find the information as intended by the authors.
Associated pull request
not yet (I do not have enough insight in asciidoc to initiate one)
Detailed Proposal
Tables missing in the List of Tables
Table caption formatting issues
Text issues
to Example 8.7 ====>>> see next point
The text was updated successfully, but these errors were encountered: