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
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...")
(No difference)

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