ABCDEFGHIJKLMNOPQRSTUVWXYZAA
1
Authoring guide structure
2
5
Level 1Level 2Level 3Reworked?PriorityRemarks
6
ConceptsWhat is Metanorma?
7
Is what you see what you get?
8
The Metanorma workflow
9
Best practice: Organizing a Metanorma project *
ToDo10Create topic
10
What is AsciiDoc?
11
Automatic numbering in Metanorma
ToDo5Refine 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 metadataCheck if link to reference docs still works after ref docs migration
20
SectionsTable of Contents generated from Section HeadingsInvestigate
21
Prefatory Sections Only placed in new location; Didn't touch the text.
22
Terms and Definitions: *ToDo6Terms 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
BibliographyToDoCompare 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 ToDo11--> figure out what to do with these sections; when figured out, update the navigation
28
29
30
31
BlocksLists`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
ImagesAlmost finished - waiting for final note from Nick
34
AdmonitionsToDo8Old content is a clarification on Notes. Check if information is outdated.
35
QuotesOnly placed in new location; Didn't touch the text.
36
Code SamplesToDo9Compare tutorial content and old content, decide what can be deleted, and what needs to be re-written.
37
Diagrams
38
Mathematical ExpressionsOnly placed in new location; Didn't touch the text.
39
Requirement, Recommendation, and Permission blocksOnly placed in new location; Didn't touch the text.
40
Passthrough to Metanorma XML and target formatsOnly placed in new location; Didn't touch the text.
41
FormsOnly placed in new location; Didn't touch the text.
42
43
Inline markupText formatting attributes
44
Footnotes
45
Links and cross referencesToDo4Compare tutorial content and old content, decide what can be deleted, and what needs to be re-written.
46
Index TermsToDo12Compare tutorial content and old content, decide what can be deleted, and what needs to be re-written.
47
Machine-readable changesToDo13Compare tutorial content and old content, decide what can be deleted, and what needs to be re-written.
48
49
50
Languages and LocalizationOnly placed in new location; Didn't touch the text.
51
CollectionsOnly placed in new location; Didn't touch the text.
52
AutomationDatamodel pluginOnly placed in new location; Didn't touch the text.
53
Yaml2Text pluginOnly placed in new location; Didn't touch the text.
54
Json2Text pluginOnly placed in new location; Didn't touch the text.
55
Automatically extracting information from MetanormaRework needed!! Only placed in new location; Didn't touch the text.
56
57
58
Reviewing documents
59
60
Generating outputValidationOnly 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 formatsOnly placed in new location; Didn't touch the text.
62
Font managementOnly 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 Attributes17--> 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 *
14Create topic
69
AsciiDoc cheat sheet *15--> replace asciidoc tips with a proper cheat sheet
70
AsciiMath16
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
OSZAR »