A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z | AA | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
1 | Authoring guide structure | ||||||||||||||||||||||||||
2 | |||||||||||||||||||||||||||
5 | Level 1 | Level 2 | Level 3 | Reworked? | Priority | Remarks | |||||||||||||||||||||
6 | Concepts | What is Metanorma? | ✅ | ||||||||||||||||||||||||
7 | Is what you see what you get? | ✅ | |||||||||||||||||||||||||
8 | The Metanorma workflow | ✅ | |||||||||||||||||||||||||
9 | Best practice: Organizing a Metanorma project * | ToDo | 10 | Create topic | |||||||||||||||||||||||
10 | What is AsciiDoc? | ✅ | |||||||||||||||||||||||||
11 | Automatic numbering in Metanorma | ToDo | 5 | Refine topic | |||||||||||||||||||||||
12 | Automatic reference lookup with Relaton | ✅ | Only placed in new location; Didn't touch the text. Check how much overlap with: https://www.metanorma.org/author/topics/building/reference-lookup/ | ||||||||||||||||||||||||
13 | Deep dive into cross-references | ✅ | |||||||||||||||||||||||||
14 | |||||||||||||||||||||||||||
15 | |||||||||||||||||||||||||||
16 | Creating a new Metanorma document * | ✅ | Topic written. Link "organizing a Metanorma project" once it exists | ||||||||||||||||||||||||
17 | |||||||||||||||||||||||||||
18 | Editing Metanorma documents | ||||||||||||||||||||||||||
19 | Adding metadata | ✅ | Check if link to reference docs still works after ref docs migration | ||||||||||||||||||||||||
20 | Sections | Table of Contents generated from Section Headings | ✅ | Investigate | |||||||||||||||||||||||
21 | Prefatory Sections | ✅ | Only placed in new location; Didn't touch the text. | ||||||||||||||||||||||||
22 | Terms and Definitions: * | ToDo | 6 | Terms and Definitions needs to be broken down in subtopics, because it is too long (1000+ lines of code!); Don't forget to update navigation in _layouts/author-docs.html if touching this topic. | |||||||||||||||||||||||
23 | Entering a term definition* | ToDo | |||||||||||||||||||||||||
24 | Bibliography | ToDo | Compare tutorial content and old content, decide what can be deleted, and what needs to be re-written. | ||||||||||||||||||||||||
25 | Entering a bibliographic entry | ✅ | |||||||||||||||||||||||||
26 | |||||||||||||||||||||||||||
27 | symbols_annex.adoc | ToDo | 11 | --> figure out what to do with these sections; when figured out, update the navigation | |||||||||||||||||||||||
28 | |||||||||||||||||||||||||||
29 | |||||||||||||||||||||||||||
30 | |||||||||||||||||||||||||||
31 | Blocks | Lists | ✅ | `start`attribute for ordered lists?, [%unnumbered] attribute | |||||||||||||||||||||||
32 | Tables | ✅ | Compare tutorial content and old content, decide what can be deleted, and what needs to be re-written | ||||||||||||||||||||||||
33 | Images | ✅ | Almost finished - waiting for final note from Nick | ||||||||||||||||||||||||
34 | Admonitions | ToDo | 8 | Old content is a clarification on Notes. Check if information is outdated. | |||||||||||||||||||||||
35 | Quotes | ✅ | Only placed in new location; Didn't touch the text. | ||||||||||||||||||||||||
36 | Code Samples | ToDo | 9 | Compare tutorial content and old content, decide what can be deleted, and what needs to be re-written. | |||||||||||||||||||||||
37 | Diagrams | ✅ | |||||||||||||||||||||||||
38 | Mathematical Expressions | ✅ | Only placed in new location; Didn't touch the text. | ||||||||||||||||||||||||
39 | Requirement, Recommendation, and Permission blocks | ✅ | Only placed in new location; Didn't touch the text. | ||||||||||||||||||||||||
40 | Passthrough to Metanorma XML and target formats | ✅ | Only placed in new location; Didn't touch the text. | ||||||||||||||||||||||||
41 | Forms | ✅ | Only placed in new location; Didn't touch the text. | ||||||||||||||||||||||||
42 | |||||||||||||||||||||||||||
43 | Inline markup | Text formatting attributes | ✅ | ||||||||||||||||||||||||
44 | Footnotes | ✅ | |||||||||||||||||||||||||
45 | Links and cross references | ToDo | 4 | Compare tutorial content and old content, decide what can be deleted, and what needs to be re-written. | |||||||||||||||||||||||
46 | Index Terms | ToDo | 12 | Compare tutorial content and old content, decide what can be deleted, and what needs to be re-written. | |||||||||||||||||||||||
47 | Machine-readable changes | ToDo | 13 | Compare tutorial content and old content, decide what can be deleted, and what needs to be re-written. | |||||||||||||||||||||||
48 | |||||||||||||||||||||||||||
49 | |||||||||||||||||||||||||||
50 | Languages and Localization | ✅ | Only placed in new location; Didn't touch the text. | ||||||||||||||||||||||||
51 | Collections | ✅ | Only placed in new location; Didn't touch the text. | ||||||||||||||||||||||||
52 | Automation | Datamodel plugin | ✅ | Only placed in new location; Didn't touch the text. | |||||||||||||||||||||||
53 | Yaml2Text plugin | ✅ | Only placed in new location; Didn't touch the text. | ||||||||||||||||||||||||
54 | Json2Text plugin | ✅ | Only placed in new location; Didn't touch the text. | ||||||||||||||||||||||||
55 | Automatically extracting information from Metanorma | ✅ | Rework needed!! Only placed in new location; Didn't touch the text. | ||||||||||||||||||||||||
56 | |||||||||||||||||||||||||||
57 | |||||||||||||||||||||||||||
58 | Reviewing documents | ✅ | |||||||||||||||||||||||||
59 | |||||||||||||||||||||||||||
60 | Generating output | Validation | ✅ | Only placed in new location; Didn't touch the text. | In links.adoc there is a notice about links and updatetype=true; Maybe include it in generating output section | ||||||||||||||||||||||
61 | Output formats | ✅ | Only placed in new location; Didn't touch the text. | ||||||||||||||||||||||||
62 | Font management | ✅ | Only placed in new location; Didn't touch the text. | ||||||||||||||||||||||||
63 | |||||||||||||||||||||||||||
64 | Troubleshooting | ✅ | Tina wrote a troubleshooting topic based on input from Nick, Nermina, and Manuel. --> Review needed. | ||||||||||||||||||||||||
65 | |||||||||||||||||||||||||||
66 | Reference documentation | ||||||||||||||||||||||||||
67 | Document Attributes | 17 | --> For each flavor, create a reference on which sections & metadata the document MUST contain. (Similar to a cheat sheet). Purpose: Making it easier to avoid errors. | ||||||||||||||||||||||||
68 | Section and Block-level Attributes * | 14 | Create topic | ||||||||||||||||||||||||
69 | AsciiDoc cheat sheet * | 15 | --> replace asciidoc tips with a proper cheat sheet | ||||||||||||||||||||||||
70 | AsciiMath | 16 | |||||||||||||||||||||||||
71 | |||||||||||||||||||||||||||
72 | Glossary * | ||||||||||||||||||||||||||
73 | |||||||||||||||||||||||||||
74 | |||||||||||||||||||||||||||
75 | |||||||||||||||||||||||||||
76 | |||||||||||||||||||||||||||
77 | |||||||||||||||||||||||||||
78 | |||||||||||||||||||||||||||
79 | |||||||||||||||||||||||||||
80 | |||||||||||||||||||||||||||
81 | |||||||||||||||||||||||||||
82 | |||||||||||||||||||||||||||
83 | |||||||||||||||||||||||||||
84 | |||||||||||||||||||||||||||
85 | |||||||||||||||||||||||||||
86 | |||||||||||||||||||||||||||
87 | |||||||||||||||||||||||||||
88 | |||||||||||||||||||||||||||
89 | |||||||||||||||||||||||||||
90 | |||||||||||||||||||||||||||
91 | |||||||||||||||||||||||||||
92 | |||||||||||||||||||||||||||
93 | |||||||||||||||||||||||||||
94 | |||||||||||||||||||||||||||
95 | |||||||||||||||||||||||||||
96 | |||||||||||||||||||||||||||
97 | |||||||||||||||||||||||||||
98 | |||||||||||||||||||||||||||
99 | |||||||||||||||||||||||||||
100 | |||||||||||||||||||||||||||
101 | |||||||||||||||||||||||||||
102 |