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

Porting Stage: Final Tasks #46

Closed
6 tasks done
tajmone opened this issue Dec 26, 2019 · 0 comments
Closed
6 tasks done

Porting Stage: Final Tasks #46

tajmone opened this issue Dec 26, 2019 · 0 comments

Comments

@tajmone
Copy link
Owner

tajmone commented Dec 26, 2019 •
edited
Loading

The last pending tasks of the AsciiDoc porting stage.

See also:
@tajmone tajmone mentioned this issue Dec 26, 2019
Closed
38 tasks
tajmone added a commit that referenced this issue Dec 26, 2019
@tajmone
Polish docs_src/README
aba9274 
Start polishing the README of the AsciiDoc sources. (See #42)

- Remove book status info.
- Polish XRefs section and refer to `CONVENTIONS.md` for custom IDs.
- Add info about dependencies version used on maintainer machine.
- Move all pending tasks to Issue #46.
tajmone added a commit that referenced this issue Jan 9, 2020
@tajmone
Fix App. A
0178594 
Proofread again "Appendix A. Summary of Keywords and Commands" and fix
minor formatting issues and other omissions (See #46):

* Fix broken/missing entries:
    * `window` (missing text)
    * `writefile` (lost entry)
* Omitted inline code style.
* Minor formatting consistency tweaks.
* Fix a couple of typos.
tajmone added a commit that referenced this issue Jan 9, 2020
@tajmone
Fix App. B
c4bb840 
Proofread again "Appendix B. The Hugo Library" and fix minor formatting
issues and other omissions (See #46):

* Amend `react_before` and `react_after`: their description was split
  across two cells: join it a a single cells spanning two rows.
* Fix other similar joint entries that needed a row-spanning desc.
* Restored missing word in description. (See #47)
* Omitted inline code style.
* Minor formatting consistency tweaks.

In "3.4. Properties", apply to the tables listing the properties of the
Hugo Library the same row-spanning definitions fixes as above.
tajmone added a commit that referenced this issue Jan 10, 2020
@tajmone
Fix App. D
663914c 
Proofread again "Appendix D. HugoFix and the Hugo Debugger" and fix
minor formatting issues and other omissions (See #46):

* Omitted inline code style.
* Minor formatting consistency tweaks.
tajmone added a commit that referenced this issue Jan 12, 2020
@tajmone
Final Proofreading: Chs 1-2
1cd30d4 
Proofread again Chapters 1 and 2, and fix minor issues (see #46):

* Styles consistency.
* Missing inline code styles.
* Minor typos.
* Fix admonitions types (e.g. from `NOTE` to `TIP`, etc.).
* Tweak source code example alignments in a few places to make them
  more friendly and intuitive.
* Add Table captions (see #42):
    * §2.3: "List of Hugo Data Types" (`table-hugo-data-types`)
tajmone added a commit that referenced this issue Jan 12, 2020
@tajmone
Final Proofreading: Ch 3
35ce473 
Proofread again Chapter 3, and fix minor issues (see #46):

* Minor typos.
* Fix admonitions types (e.g. from `NOTE` to `TIP`, etc.).
* In "§3.4. Properties", fix the library aliases definitions (broken).
tajmone added a commit that referenced this issue Jan 12, 2020
@tajmone
Final Proofreading: Ch 4
c4b4670 
Proofread again Chapter 4, and fix minor issues (see #46):

* Minor typos.
* Styles consistency.
* Missing inline code styles.
* Fix admonitions types (e.g. from `NOTE` to `TIP`, etc.).
* Add Table captions (see #42):
    * §4.1: "Global Variables Defined by the Hugo Engine"
      (`table-engine-globals`)
tajmone added a commit that referenced this issue Jan 13, 2020
@tajmone
Final Proofreading: Ch 5
fd04cfb 
Proofread again Chapter 5, and fix minor issues (see #46):

* Hugo code vs syntax definitions styles.
* Transcript vs verbatim styles.
* Missing inline code styles.
* Styles consistency.
tajmone added a commit that referenced this issue Jan 13, 2020
@tajmone
Final Proofreading: Ch 6
b2b5b60 
Proofread again Chapter 6, and fix minor issues (see #46):

* Styles consistency.
* Missing inline code styles.
* Amend broken code examples (missing tokens).
tajmone added a commit that referenced this issue Jan 15, 2020
@tajmone
Final Proofreading: Ch 7
6d963c9 
Proofread again Chapter 7, and fix minor issues (see #46):

* Hugo code vs syntax definitions styles.
* Add anchors and cross references for dynamic grammars (See #22):
    * §7.1  (`dynamic-grammars1`)
    * Ch.17 (`dynamic-grammars2`)
* Missing inline code styles.
* Styles consistency.
* Minor typos.
tajmone added a commit that referenced this issue Jan 15, 2020
@tajmone
Final Proofreading: Ch 7
21757cd 
Proofread again Chapter 7, and fix minor issues (see #46):

* Hugo code vs syntax definitions styles.
* Add anchors and cross references for dynamic grammars (See #22):
    * §7.1  (`dynamic-grammars1`)
    * Ch.17 (`dynamic-grammars2`)
* Missing inline code styles.
* Styles consistency.
* Minor typos.
tajmone added a commit that referenced this issue Jan 15, 2020
@tajmone
Final Proofreading: Ch 7
ecd2f66 
Proofread again Chapter 7, and fix minor issues (see #46):

* Hugo code vs syntax definitions styles.
* Add anchors and cross references for dynamic grammars (See #22):
    * §7.1  (`dynamic-grammars1`)
    * Ch.17 (`dynamic-grammars2`)
* Missing inline code styles.
* Styles consistency.
* Minor typos.
tajmone added a commit that referenced this issue Jan 15, 2020
@tajmone
Final Proofreading: Ch 7
f265af6 
Proofread again Chapter 7, and fix minor issues (see #46):

* Hugo code vs syntax definitions styles.
* Add anchors and cross references for dynamic grammars (See #48):
    * §7.1  (`dynamic-grammars1`)
    * Ch.17 (`dynamic-grammars2`)
* Missing inline code styles.
* Styles consistency.
* Minor typos.
tajmone added a commit that referenced this issue Jan 16, 2020
@tajmone
Final Proofreading: Ch 8
479f5aa 
Proofread again Chapter 8, and fix minor issues (see #46):

* Minor typos.
* Fix admonitions types (e.g. from `NOTE` to `TIP`, etc.).
* Table captions (see #42):
    * EDIT: §4.1: "Predefined Global Variables"
      (`table-engine-variables`)
    * ADD: §8.1: "Predefined Global Variables and Properties"
      (`table-engine-globals`)
    * ADD: §8.3: "Default ParseError Responses"
      (`table-parseerror-responses`)

Global changes:

* Optimize tables definitions.
* Add a `{wj}` attribute before footnotes to insert a word joiner (WJ)
  that prevents wrapping that separates a footnote number from its
  inline text.
tajmone added a commit that referenced this issue Jan 16, 2020
@tajmone
Final Proofreading: Ch 9
7864f5c 
Proofread again Chapter 9, and fix minor issues (see #46):

* Styles consistency.
* Missing inline code styles.
* Fix admonitions types (e.g. from `NOTE` to `TIP`, etc.).
* Hugo code vs syntax definitions styles.
tajmone added a commit that referenced this issue Jan 17, 2020
@tajmone
Final Proofreading: Ch 10
7b91d95 
Proofread again Chapter 10, and fix minor issues (see #46):

* Styles consistency.
* Fix wrong inline code formatting for `plural_class` mentioning:
    * "`plural` class" => "plural class"
tajmone added a commit that referenced this issue Jan 17, 2020
@tajmone
Final Proofreading: Chs 11-12
f921dd7 
Proofread again Chapters 11-12, and fix minor issues (see #46):

* Styles consistency.
* Missing inline code styles.
* §11.1. Convert "display object properties" from description list to
  table in order to allow a description to span two cells vertically.

Chapter 12 didn't require any fixes at all.
tajmone added a commit that referenced this issue Jan 17, 2020
@tajmone
Final Proofreading: App. E-G
4b49889 
Proofread again Appendices E-G, and fix minor issues (see #46).
No changes required for Appendices F and G.

App E:

* Styles consistency.
* Fix CMD => Hugo syntax definitions styles.

With this commit, final proofreading of Book I is completed.

NOTE: Appendices A-D were already proofread before, so they are skipped.
tajmone added a commit that referenced this issue Jan 18, 2020
@tajmone
Final Proofreading Book II: Chs 13-14
f36e434 
Proofread again Chapter 13-14, and fix minor issues (see #46):

* Minor typos.
* Ch. 13: fix dead link to IF Archive (ftp:// => https://).
* Ch 14: clean-up and optimize tables.
* Table captions (see #42):
    * ADD: §14.1: "Memory Map of a .HEX File"(`table-hex-file-map`)
tajmone added a commit that referenced this issue Jan 18, 2020
@tajmone
Final Proofreading: Chs 15-24
d7402d2 
Proofread again Chapter 15-24, and fix minor issues (see #46).

Chapters 15, 16, 18-20 and 22-24 didn't require any changes.

* In Chs. 17 and 21 amend links referring to Book I so that they point
  to the specific chapter of relevance:
    * Ch 17:  "see the Hugo Manual." => §7.1. Grammar Definition
    * §21.1:  "see the Hugo Manual." => §5.3. Before and After Routines
tajmone added a commit that referenced this issue Jan 19, 2020
@tajmone
Final Proofreading: Chs 25-7
eb878a9 
Proofread again Chapter 25-7, and fix minor issues (see #46).

* Figures and Tables captions (see #42):
    * Ch.25: "Flowchart of the Hugo Compiler" (`fig-compiler-flowchart`)
    * Ch.26: "Flowchart of the Hugo Engine"   (`fig-engine-flowchart`)
    * Ch.27: "Flowchart of the Hugo Debugger" (`fig-debugger-flowchart`)
    * §27.2: "Memory Map of a .HDX File"      (`table-hdx-file-map`)
tajmone added a commit that referenced this issue Jan 19, 2020
@tajmone
Final Proofreading: App. H
4811cf9 
Proofread again Appendix H, and fix minor issues (closes #46).

* Minor typos.
* Add admonition blocks.
* Replace with a non-breaking space attribute (`{nbsp}`) all occurrences
  of spaces inside mono-spaced parameters (e.g. `<object{nbsp}number>`)
  to prevent text wrapping in the middle of the mono-spaced token.
* Style tokens in the table as `[.big.red]#` to simplify visually
  locating them during look-up operations.

This commit ends the final proofreading of the book.
@tajmone tajmone closed this as completed Jan 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@tajmone