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

Fix All XRefs #25

Closed
19 of 20 tasks
tajmone opened this issue Nov 1, 2019 · 0 comments
Closed
19 of 20 tasks

Fix All XRefs #25

tajmone opened this issue Nov 1, 2019 · 0 comments
Labels
⭐ xrefs Topic: Cross reference labels and issues ⚠️ important Priority: High
Milestone
xrefs

Comments

@tajmone
Copy link
Owner

tajmone commented Nov 1, 2019 •
edited
Loading

Fix all XRefs present in The Hugo Book, using the generated auto-ID.

  • BOOK I. THE HUGO PROGRAMMING MANUAL
    • 1. INTRODUCTION
    • 2. A FIRST LOOK AT HUGO
    • 3. OBJECTS
    • 4. HUGO PROGRAMMING
    • 5. ROUTINES AND EVENTS
    • 8. JUNCTION ROUTINES
    • 12. RESOURCES
    • APP. A. SUMMARY OF KEYWORDS AND COMMANDS
    • APP. B. THE HUGO LIBRARY
  • BOOK II. TECHNICAL SYSTEM SPECIFICATION
    • 13. INTRODUCTION
    • 14. ORGANIZATION OF THE .HEX FILE
    • 16. ENGINE PARSING
    • 17. GRAMMAR
    • 18. EXECUTABLE CODE
    • 21. THE PROPERTY TABLE
    • 27. DARK SECRETS OF THE HUGO DEBUGGER
    • APP. H. CODE PATTERNS
  • Other xrefs pointing to inline anchors.

NOTE 1 — Generated auto-IDs won't have a leading underscore due to :idprefix: being unset in the header.

NOTE 2 — This might not be the best solution for handling chuncked documnets, due to some sections sharing the same titles (e.g. "Introduction", or "Limit Settings").

But it will do for now, since we're building just a single HTML document. In the future we need to manually customize every cross-referenced ID (see #26) for consistency sake and to ensure that xrefs will work also on split-chapter contents, like website, CHM, etc.
@tajmone tajmone added ⚠️ important Priority: High ⭐ xrefs Topic: Cross reference labels and issues labels Nov 1, 2019
@tajmone tajmone added this to the xrefs milestone Nov 1, 2019
tajmone added a commit that referenced this issue Nov 1, 2019
@tajmone
Fix XRefs
93c6270 
* Fix all cross references to the following chapters and sections:
    * 5.1. Routines
    * 5.3. Before and After Routines
    * 7.1. Grammar Definition
    * 8.7. Perform
    * 9. The Game Loop
* Fix a previously missed xref to:
    * App. H: Code Patterns (2 total xrefs, now)

This commit fixes all xrefs in the following chapters (See #25):
    * 5. Routines and Events
    * 14. Organization of the .HEX File
tajmone added a commit that referenced this issue Nov 1, 2019
@tajmone
Fix Internal XRefs in Book I Intro
81d348c 
* Fix all internal cross references to the following sections:
    * 1.5. Packing List
    * 1.9. Compiler Switches
    * 1.10. Limit Settings
    * 1.11. Directories

This commit fixes all xrefs in the following chapters (See #25):
    * 1. Introduction
tajmone added a commit that referenced this issue Nov 1, 2019
@tajmone
Fix XRefs to Ch 2, 14
31aa412 
* Fix all cross references to the following sections:
    * 2.3. Data Types
    * 14.2. The Header

This commit fixes all xrefs in the following chapters (See #25):
    * 27. Dark Secrets of the Hugo Debugger
tajmone added a commit that referenced this issue Nov 1, 2019
@tajmone
Fix XRefs to Ch 3, 15
f152c3f 
* Fix all cross references to the following sections (See #25):
    * 3.5. Classes
    * 15.2. Data Types

In "§15.2. Data Types", add a custom ID (`[#15-2_data_types]`) to
prevent conflicts with "§2.3. Data Types".
tajmone added a commit that referenced this issue Nov 1, 2019
@tajmone
Fix XRefs to Ch 4, 11
0a2bee5 
* Fix all cross references to the following sections (See #25):
    * 4.5. Operators and Assignments
    * 4.7. Conditional Expressions and Program Flow
    * 11.1. The Display Object

This commit fixes all xrefs in the following chapters (See #25):
    * 2. A First Look at Hugo
    * 3. Objects
tajmone added a commit that referenced this issue Nov 1, 2019
@tajmone
Fix XRefs to Ch 7, 23
f3e5d85 
* Fix all cross references to the following sections:
    * 7.2. The Parser
    * 23.2. Special Words

This commit fixes all xrefs in the following chapters (See #25):
    * 16. Engine Parsing
tajmone added a commit that referenced this issue Nov 1, 2019
@tajmone
Fix XRefs to Ch 25 and Hugo Manual
9869d38 
* Fix all cross references to:
    * 25.2. The Linker
    * The Hugo Programming Manual
* Add custom ID to Book I (`book1`).

This commit fixes all xrefs in the following chapters (See #25):
    * 13. Introduction
    * 17. Grammar
    * 21. The Property Table
tajmone added a commit that referenced this issue Nov 1, 2019
@tajmone
Fix XRefs
7dc12f3 
* Fix cross references to:
    * 12. Resources
    * Custom anchor in §12.1, pointing to `system_status` return values.

This commit fixes all xrefs in the following chapters (See #25):
    * 4. Hugo Programming
tajmone added a commit that referenced this issue Nov 2, 2019
@tajmone
Fix All Remaining XRefs
b728972 
* Fix cross references to:
    * App. B.4. Constants
    * App. H. Code Patterns

This commit fixes all remaining xrefs in the book (closes #25).
@tajmone tajmone closed this as completed Nov 2, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
⭐ xrefs Topic: Cross reference labels and issues ⚠️ important Priority: High
Projects
None yet
Milestone
xrefs
Development

No branches or pull requests
1 participant
@tajmone