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

Formatting of local links in text; Lists of Figures, Tables and Examples #499

Open
larsbarring opened this issue Dec 19, 2023 · 14 comments · May be fixed by #565
Open

Formatting of local links in text; Lists of Figures, Tables and Examples #499

larsbarring opened this issue Dec 19, 2023 · 14 comments · May be fixed by #565
Labels
CF1.12? We might conclude this issue in time for CF1.12 defect Conventions text meaning not as intended, misleading, unclear, has typos, format or language errors

Comments

@larsbarring
Copy link
Contributor

larsbarring commented Dec 19, 2023

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

  • The formatting of Lists of Tables, Figures and Examples should be harmonised. In my view the List of Tables and List of Examples are good (however, see below). The List of Figures should be changed to conform to these two. This is done by changing the format of the Figure captions.
  • Several items are not included in the list of Tables and Figures because of formatting problems, cf. details below.

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 7.1
  • Table 9.1
  • Table 9.2
  • Table 9.3
  • Table 9.4
  • Table D.2
  • Table J.1

Table caption formatting issues

  • Table 3.1: -- which Example; 3.8?
  • Table 3.2: -- which Example; 3.8?
  • Table D.1: -- "Table D.1" is missing, and complex entry in the List of Tables
  • Table D.2: -- "Table D.2" is missing
  • Table I.1: -- complex entry in the List of Tables, -- contains malformed figure reference
  • Table I.2: -- complex entry in the List of Tables, -- contains malformed figure references
  • Table J.1: -- no table caption at all, is currently formatted as subsection "Common Conversions and Formulas"

Text issues

  • Section 1.3, first sentence: -- check reference NUG for formatting (appears three times)
  • Section 1.3, "coordinate variable": -- change square brackets to parentheses in "[e.g., time(time)]"
  • 4.3.1. Dimensional Vertical Coordinate, first sentence: -- does not make sense, something is missing
  • Check many references to "[NUG]" and to "[UDUNITS]" for consistency
  • Section "Bounds Tie Point Attribute and Bounds Tie Point Variable" under ch.8.3.8: -- contains malformed reference
    to Example 8.7 ====>>> see next point
  • Example 8.7 caption: -- contains malformed figure reference
  • Section 8.3.10 -- table contains double "[[" and "]]"
  • Appx. F, Polar Stereographic: -- internal link to Snyder not active
@larsbarring larsbarring added the defect Conventions text meaning not as intended, misleading, unclear, has typos, format or language errors label Dec 19, 2023
@JonathanGregory
Copy link
Contributor

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

@JonathanGregory JonathanGregory added the CF1.12? We might conclude this issue in time for CF1.12 label Oct 20, 2024
@davidhassell
Copy link
Contributor

davidhassell commented Nov 12, 2024

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:
cf-conventions.html.gz

@larsbarring or @JonathanGregory - could you have a glance over this, perhaps?

Many thanks,
David

@DocOtak
Copy link
Member

DocOtak commented Nov 12, 2024

@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.

@davidhassell
Copy link
Contributor

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 :)

@JonathanGregory
Copy link
Contributor

Dear @davidhassell

Thanks for this great effort! In looking through the PR, I've noted three places where perhaps we could have just <<NUG>>. I also made comments, and then resolved them, because of what looked like double refs to the tables in Sect 9, but it's correct in the HTML, so you must have the right incantation there.

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?

7.1. figure 1
7.2. figure 2

Best wishes

Jonathan

@DocOtak
Copy link
Member

DocOtak commented Nov 13, 2024

@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.

@davidhassell
Copy link
Contributor

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.

@davidhassell
Copy link
Contributor

davidhassell commented Nov 14, 2024

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.

@davidhassell
Copy link
Contributor

New rendering: cf-conventions.html.gz

@davidhassell
Copy link
Contributor

@DocOtak

Oh, I see :) I'll delete the file and re-instate the comment.

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

@JonathanGregory
Copy link
Contributor

Thanks, David. It's a shame that asciidoc isn't as clever as $\LaTeX$.

@larsbarring
Copy link
Contributor Author

I asked a question about that over at the asciidoc support forum.

@JonathanGregory
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CF1.12? We might conclude this issue in time for CF1.12 defect Conventions text meaning not as intended, misleading, unclear, has typos, format or language errors
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants