458
edits
| As of August 2020 the site you are on (wiki.newae.com) is deprecated, and content is now at rtfm.newae.com. |
Changes
no edit summary
When editing the ChipWhisperer wiki, there is a few things are some general guidelines that you have to keep in mindshould be followed. This page covers many most of these thingsguidelines.
{{TOC|limit== Things not to do ==* 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.3}}
== Things you should do 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.
* 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 ==
Some awesome content of this higher level
</pre>
== Collapsible Sections ==
* 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.
<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}}
== Including Related Links ==
All tutorials include the tutorials info box at the end of the page using
<pre>== Links ==
{{Template:Tutorials}}
</pre>
All target pages include the target info box at the end of the page using
<pre>== Hardware ==
{{Template:Hardware}}
</pre>
== Alert boxes ==
To add a warning/caution box within you content use <pre>{{Warningbox|Approach this with caution}}</pre>
which will render as:
{{Warningbox|Approach this with caution}}
A green/info box is also available, to add this use <pre>{{Greenbox|A quick note for something that is important to read/do}}</pre>
this will render as:
{{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.
