| As of August 2020 the site you are on (wiki.newae.com) is deprecated, and content is now at rtfm.newae.com. |
Difference between revisions of "Style Guide"
From ChipWhisperer Wiki
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | When editing the ChipWhisperer wiki, there | + | When editing the ChipWhisperer wiki, there are some general guidelines that should be followed. This page covers most of these guidelines. |
| + | |||
| + | {{TOC|limit=3}} | ||
== Heading Organization == | == Heading Organization == | ||
* Do not use <code><h1></code> tags, this includes the mediawiki syntax <code> = H1 Title = </code> because this should be reserved for the title of the page. | * Do not use <code><h1></code> tags, this includes the mediawiki syntax <code> = H1 Title = </code> because this should be reserved for the title of the page. | ||
* Use <code><h2></code> tags for the main groupings as these will be rendered as the highest level color sections. | * Use <code><h2></code> tags for the main groupings as these will be rendered as the highest level color sections. | ||
| + | {{Greenbox|Use h2 - h6 as you would normally and usually the styling will look just fine. Only when using collapsible sections is it important to read [[:Style Guide#Collapsible Sections|Collapsible Sections]]}} | ||
<pre>== Title of the highest level colored section == | <pre>== Title of the highest level colored section == | ||
Some awesome content of this higher level | Some awesome content of this higher level | ||
| Line 11: | Line 14: | ||
* If you plan on including a page as a collapsible section use <code><h4></code> This will render a slightly darker colored section that is contained within the larger colored section. | * If you plan on including a page as a collapsible section use <code><h4></code> This will render a slightly darker colored section that is contained within the larger colored section. | ||
* <code><h3></code> is not left out, it is used for the header that is displayed as the collapsible section's header. | * <code><h3></code> is not left out, it is used for the header that is displayed as the collapsible section's header. | ||
| + | <pre>{{CollapsibleSection | ||
| + | |intro = === Collapsible Section === | ||
| + | |content= Style Guide/Example Collapsible Section}} | ||
| + | </pre> | ||
| + | will render as: | ||
| + | {{CollapsibleSection | ||
| + | |intro = === Collapsible Section === | ||
| + | |content= Style Guide/Example Collapsible Section}} | ||
| − | == Related | + | == Including Related Links == |
All tutorials include the tutorials info box at the end of the page using | All tutorials include the tutorials info box at the end of the page using | ||
<pre>== Links == | <pre>== Links == | ||
| Line 29: | Line 40: | ||
this will render as: | this will render as: | ||
{{Greenbox|A quick note for something that is important to read/do}} | {{Greenbox|A quick note for something that is important to read/do}} | ||
| + | |||
| + | == Info Boxes == | ||
| + | Target should include an info box on top right side of the page. See [[CW308T-MSP430FR5]] for an example. | ||
Latest revision as of 13:42, 1 May 2018
When editing the ChipWhisperer wiki, there are some general guidelines that should be followed. This page covers most of these guidelines.
Heading Organization
- Do not use
<h1>tags, this includes the mediawiki syntax= H1 Title =because this should be reserved for the title of the page. - Use
<h2>tags for the main groupings as these will be rendered as the highest level color sections.
Use h2 - h6 as you would normally and usually the styling will look just fine. Only when using collapsible sections is it important to read Collapsible Sections
== Title of the highest level colored section == Some awesome content of this higher level
Collapsible Sections
- If you plan on including a page as a collapsible section use
<h4>This will render a slightly darker colored section that is contained within the larger colored section. -
<h3>is not left out, it is used for the header that is displayed as the collapsible section's header.
{{CollapsibleSection
|intro = === Collapsible Section ===
|content= Style Guide/Example Collapsible Section}}
will render as:
Collapsible Section
Section inside a collapsible section
Some cool and interesting stuff within this section.
Second section inside the same collapsible section
The second coolest stuff within the second section.
Collapsible Section === ==== Section inside a collapsible section =
Some cool and interesting stuff within this section.
Second section inside the same collapsible section
The second coolest stuff within the second section.
Including Related Links
All tutorials include the tutorials info box at the end of the page using
== Links ==
{{Template:Tutorials}}
All target pages include the target info box at the end of the page using
== Hardware ==
{{Template:Hardware}}
Alert boxes
To add a warning/caution box within you content use{{Warningbox|Approach this with caution}}
which will render as:
Approach this with caution
{{Greenbox|A quick note for something that is important to read/do}}
this will render as:
A quick note for something that is important to read/do
Info Boxes
Target should include an info box on top right side of the page. See CW308T-MSP430FR5 for an example.
