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.

Sign up for GitHub

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

Jump to bottom

Customize IDs of Every Book Sections #26

Closed
16 tasks done
tajmone opened this issue Nov 1, 2019 · 0 comments
Closed
16 tasks done

Customize IDs of Every Book Sections #26

tajmone opened this issue Nov 1, 2019 · 0 comments
Labels
🕑 pending decision Issue requires decisions by maintainers 👮 formatting conventions Policies: AsciiDoc formatting conventions. ⭐ xrefs Topic: Cross reference labels and issues
Projects
Porting
Milestone
xrefs

Comments

@tajmone
Copy link
Owner

tajmone commented Nov 1, 2019 •
edited

Customize all Section IDs.

  • Choose a standard naming convention for:
    • Parts — Books I/II <h1>.
    • Chapters — <h2>.
    • Appendixes — <h2>.
    • Sections — <h3> to <h4>.
  • Document it in CONVENTIONS.md
  • Replace every auto-generated ID in the book with a custom ID:
    • Parts.
    • Chapters Titles.
      • Level 3 Chapters Subsections.
      • Level 4 Chapters Subsections.
    • Appendices Titles.
      • Level 3 Appendices Subsections.
      • Level 4 Appendices Subsections.
  • Fix all existing xrefs, using the new ID.
  • Fix Live HTML Preview links in docs_src/README.md

NOTE 1 — In order to preserve anchors consistency across the book, define custom IDs for all chapters, sections and appendices titles.

NOTE 2 — After these changes, all existing Live HTML Preview links to the book inside Issues will be broken. I'll try to fix them in all open Issues as I handle them.

References
@tajmone tajmone added the ⭐ xrefs Topic: Cross reference labels and issues label Nov 1, 2019
@tajmone tajmone added this to the xrefs milestone Nov 1, 2019
@tajmone tajmone added this to To do in Porting via automation Nov 1, 2019
@tajmone tajmone mentioned this issue Nov 1, 2019
Closed
20 tasks
@tajmone tajmone added 🕑 pending decision Issue requires decisions by maintainers 👮 formatting conventions Policies: AsciiDoc formatting conventions. labels Nov 30, 2019
@tajmone tajmone pinned this issue Nov 30, 2019
tajmone added a commit that referenced this issue Nov 30, 2019
@tajmone
Update Project Docs
24bf90a 
* 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 added a commit that referenced this issue Nov 30, 2019
@tajmone
Custom IDs: Level 1
8d855d5 
Add custom IDs following the newly established convention: (See #26)

 * All Level 1 headings (Chapters and Appendices).
 * "Author's Foreword" -> `preface`.
tajmone added a commit that referenced this issue Nov 30, 2019
@tajmone
Custom IDs Level 2-3: Chs 1-2
7a33f06 
Add custom IDs following the newly established convention (See #26) to
all Level 2-3 headings in the following Chapters:

  1. Introduction.
  2. A First Look at Hugo

Fix previous xrefs accordingly.
tajmone added a commit that referenced this issue Nov 30, 2019
@tajmone
Custom IDs Level 2-3: Chs 3-4, App B
cebd8f0 
Add custom IDs following the newly established convention (See #26) to
all Level 2-3 headings in the following Chapters:

  - 3. Objects.
  - 4. Hugo Programming
  - Appendix B: The Hugo Library

Fix previous xrefs accordingly.

Slightly tweaked footnote n° 8 for better readability:

* was: "The section Sec. 4.5, “Operators and Assignments” goes into ..."
* now:  "Sec. 4.5, “Operators and Assignments” goes into ..."
tajmone added a commit that referenced this issue Nov 30, 2019
@tajmone
Custom IDs Level 2-3: Chs 5-8
f412e5c 
Add custom IDs following the newly established convention (See #26) to
all Level 2-3 headings in the following Chapters:

  - 5. Routines and Events
  - 6. Fuses, Daemons, and Scripts
  - 7. Grammar and Parsing
  - 8. Junction Routines

Fix previous xrefs accordingly.
tajmone added a commit that referenced this issue Nov 30, 2019
@tajmone
Custom IDs Level 2-3: Chs 9-12
13f5762 
Add custom IDs following the newly established convention (See #26) to
all Level 2-3 headings in the following Chapters:

  - 9. The Game Loop
  - 10. Using the Object Library
  - 11. Advanced Features
  - 12. Resources

Fix previous xrefs accordingly.
tajmone added a commit that referenced this issue Nov 30, 2019
@tajmone
Custom IDs Level 2-3: App D, Chs 13-14
6a466bf 
Add custom IDs following the newly established convention (See #26) to
all Level 2-3 headings in the following Chapters:

  - App. D. HugoFix and the Hugo Debugger
  - 13. Introduction
  - 14. Organization of the .HEX File

Fix previous xrefs accordingly.
tajmone added a commit that referenced this issue Dec 1, 2019
@tajmone
Custom IDs Level 2-3: Chs 15, 18, 20-21, 23
22726d6 
Add custom IDs following the newly established convention (See #26) to
all Level 2-3 headings in the following Chapters:

  - 15. Tokens and Data Types
  - 18. Executable Code
  - 20. The Object Table
  - 21. The Property Table
  - 23. The Dictionary and Special Words

Fix previous xrefs accordingly.
tajmone added a commit that referenced this issue Dec 1, 2019
@tajmone
Complete Custom IDs Level 2-3: Chs 25-27
b0b2a4a 
* Add custom IDs following the established convention to all Level 2-3
  headings in the following Chapters:

  - 25. The Hugo Compiler and How It Works
  - 26. The Hugo Engine and How It Works
  - 27. Dark Secrets of the Hugo Debugger

* Fix previous xrefs accordingly.
* Fix all links in `docs_src/README.md`

(Closes #26)
@tajmone tajmone closed this as completed Dec 1, 2019
Porting automation moved this from To do to Done Dec 1, 2019
@tajmone tajmone unpinned this issue Dec 1, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
🕑 pending decision Issue requires decisions by maintainers 👮 formatting conventions Policies: AsciiDoc formatting conventions. ⭐ xrefs Topic: Cross reference labels and issues
Projects
No open projects
Porting
  
Done
Milestone
xrefs
Development

No branches or pull requests
1 participant
@tajmone