Difference between revisions of "Style Guide"

From ChipWhisperer Wiki
Jump to: navigation, search
Line 1: Line 1:
 
When editing the ChipWhisperer wiki, there is a few things that you have to keep in mind. This page covers many of these things.
 
When editing the ChipWhisperer wiki, there is a few things that you have to keep in mind. This page covers many of these things.
  
== Things not to do ==
+
== Heading Organization ==
 
* Do not use <code>&lt;h1&gt;</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>&lt;h1&gt;</code> tags, this includes the mediawiki syntax <code> = H1 Title = </code> because this should be reserved for the title of the page.
 
== Things you should do ==
 
 
* Use <code>&lt;h2&gt;</code> tags for the main groupings as these will be rendered as the highest level color sections.
 
* Use <code>&lt;h2&gt;</code> tags for the main groupings as these will be rendered as the highest level color 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
 
</pre>
 
</pre>
 +
 +
== Collapsible Sections ==
 
* If you plan on including a page as a collapsible section use <code>&lt;h4&gt;</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>&lt;h4&gt;</code> This will render a slightly darker colored section that is contained within the larger colored section.
 
* <code>&lt;h3&gt;</code> is not left out, it is used for the header that is displayed as the collapsible section's header.
 
* <code>&lt;h3&gt;</code> is not left out, it is used for the header that is displayed as the collapsible section's header.
=== Related links at the end of the page ===
+
 
 +
== Related links at the end of the page ==
 
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 20: Line 21:
 
{{Template:Hardware}}
 
{{Template:Hardware}}
 
</pre>
 
</pre>
=== Alert boxes ===
+
 
 +
== Alert boxes ==
 
To add a warning/caution box within you content use <pre>{{Warningbox|Approach this with caution}}</pre>  
 
To add a warning/caution box within you content use <pre>{{Warningbox|Approach this with caution}}</pre>  
 
which will render as:  
 
which will render as:  

Revision as of 12:28, 1 May 2018

When editing the ChipWhisperer wiki, there is a few things that you have to keep in mind. This page covers many of these things.

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.
== 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.

Related links at the end of the page

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

A green/info box is also available, to add this use
{{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