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

Section Numbering in Book II #4

Open
tajmone opened this issue Oct 11, 2019 · 0 comments
Open

Section Numbering in Book II #4

tajmone opened this issue Oct 11, 2019 · 0 comments
Labels
👑 HTML Issues with conversion to HTML format 🔨 Asciidoctor Tool: Asciidoctor 🔬 research Issue requires further researching ⚠️ important Priority: High
Projects
Milestone

Comments

@tajmone
Copy link
Owner

tajmone commented Oct 11, 2019

Section numbering of Book II will be inconsistent when publishing the book into split files.

Currently, there seems to be no way to control/reset section numbering in Asciidoctor.

This means that, when publishing The Hugo Book as a single-file document, section numbers in Book II (i.e., chapters and appendices) will carry on from Book I — with Introduction of Book II being numbered as §13.

If we publish the two book parts as independent files, section numbering of Book II will be independent from Book I — with Introduction of Book II being numbered as §1.

The latter mirrors the actual numbering of the official Hugo Book PDF document, and it would be desirable to preserve this kind of numbering — we're already trading off roman-numbering of sections for arabic-numbering.

In any case, having different section numbers across the various editions (single doc, split by book parts, or one doc per section) would create unnecessary confusion to the readers, and consistent numbering is preferable.

Beside this general problem regarding section numbering control of the two book parts, there are other technical problems affecting publications as one-section per document — i.e. HTML chunking.

References

See Issues:

See Asciidoctor Manual:

@tajmone tajmone added ⚠️ important Priority: High 👑 HTML Issues with conversion to HTML format 🔨 Asciidoctor Tool: Asciidoctor 🔬 research Issue requires further researching labels Oct 11, 2019
@tajmone tajmone added this to To do in Porting Oct 20, 2019
tajmone added a commit that referenced this issue Nov 30, 2019
* In `CONVENTIONS.md` explain:
    * Book sections organization.
    * Sections numbering (original vs new edition | See #4).
    * Define rules for custom IDs. (See #26)
* Clean-up `docs_src/README.md`.
@tajmone tajmone added this to To do in Long Term via automation Jan 20, 2020
@tajmone tajmone removed this from To do in Porting Jan 20, 2020
@tajmone tajmone added this to the plus ultra milestone Jan 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
👑 HTML Issues with conversion to HTML format 🔨 Asciidoctor Tool: Asciidoctor 🔬 research Issue requires further researching ⚠️ important Priority: High
Projects
Long Term
  
To do
Development

No branches or pull requests

1 participant