Difference between revisions of "Style Guide"

From ChipWhisperer Wiki
Jump to: navigation, search
(Created page with "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 == * Do not use <code>&lt...")
 
Line 11: Line 11:
 
* 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 ===
 +
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}}

Revision as of 12:26, 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.

Things not to do

  • Do not use <h1> tags, this includes the mediawiki syntax = H1 Title = because this should be reserved for the title of the page.

Things you should do

  • 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
  • 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