Wiki page template: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 5: | Line 5: | ||
# Bottom | # Bottom | ||
The top section is the | The top section is the ''intro'' to the subject that is a brief overview of the entire subject. It invites the reader to move into the subject. | ||
The middle section of a page is the main body. It contains all the relevant details of the subject. It should be designed to make it easy for the reader to navigate through the most important ideas in the subject. | The middle section of a page is the main body. It contains all the relevant details of the subject. It should be designed to make it easy for the reader to navigate through the most important ideas in the subject. | ||
| Line 35: | Line 35: | ||
The following sections are bottom matter for the page, ''outro''. | The following final sections are bottom matter for the page, ''outro''. | ||
== Math == | == Math == | ||
Latest revision as of 12:12, 3 July 2023
This is the self-referential template for typical pages in the DGF wiki. This top section gives a brief introduction to the subject. Pages are broken down into three parts
- Top
- Middle
- Bottom
The top section is the intro to the subject that is a brief overview of the entire subject. It invites the reader to move into the subject.
The middle section of a page is the main body. It contains all the relevant details of the subject. It should be designed to make it easy for the reader to navigate through the most important ideas in the subject.
The bottom section of a page contains outros to the page. This information contains links to leave the subject (other pages in the wiki or links away from the wiki) or snippets that definitively conclude a topic.
The next three sections in this Wiki page template are the main body of the page.
Background/Overview[edit | edit source]
The page then has a more extended discussion on the subject from a high-level. Think of this section as marketing for and history of the subject. It should include all the past understanding and conclusions on the subject, but not the thinking behind it--that's for the next section.
Theory/Mechanism/System design[edit | edit source]
More rigorous and detailed discussion follows. This section explains the reasons for why the subject has been developed.
In the DGF wiki, we link the first mention of a concept with its own page, but not subsequent mentions. (For example, the term "DGF wiki" in this page follows this convention.)
Applications[edit | edit source]
In this section we detail the uses of the subject of the page. Each application will have a subheading as follows
First application[edit | edit source]
Main page: First application
Typically these uses are too complicated to completely describe in this page so there will be a link to the main page (as shown above in italics) followed by a summary, here.
Second application[edit | edit source]
Main page: Second application
This is the end of the main body.
The following final sections are bottom matter for the page, outro.
Math[edit | edit source]
Links to details justifying the conclusions of the main body.
Code[edit | edit source]
Links to details implementing the conclusions of the main body.
Downloads[edit | edit source]
Links to working applications that incorporate the code.
See Also[edit | edit source]
- Proposals for important changes in the subject are usually given in the Discussion page. Just click on "Discussion" at the top of the page.