Style Guide - Revision history

Fheubach at 20:42, 1 May 2018

2018-05-01T20:42:14Z

Fheubach at 20:41, 1 May 2018

2018-05-01T20:41:16Z

Fheubach at 19:42, 1 May 2018

2018-05-01T19:42:14Z

Fheubach at 19:41, 1 May 2018

2018-05-01T19:41:30Z

Fheubach at 19:34, 1 May 2018

2018-05-01T19:34:39Z

Fheubach: /* Collapsible Sections */

2018-05-01T19:34:05Z

‎Collapsible Sections

Fheubach at 19:28, 1 May 2018

2018-05-01T19:28:49Z

Fheubach at 19:26, 1 May 2018

2018-05-01T19:26:32Z

Fheubach: 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 `<..."`


2018-05-01T19:15:41Z
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..."
New page
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;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.

<pre>== Title of the highest level colored section ==

Some awesome content of this higher level

</pre>

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

← Older revision		Revision as of 20:42, 1 May 2018
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 are some general guidelines that should be followed. This page covers most of these guidelines.

	{{TOC\|limit=3}}		{{TOC\|limit=3}}

@@ 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.
 == Heading Organization ==
@@ Line 21: / Line 23: @@
 |content= Style Guide/Example Collapsible Section}}
-== Related links at the end of the page ==
+== Including Related Links ==
 All tutorials include the tutorials info box at the end of the page using
 <pre>== Links ==
@@ Line 38: / Line 40: @@
 this will render as:
 {{Greenbox|A quick note for something that is important to read/do}}

@@ Line 16: / Line 16: @@
 </pre>
 will render as:
 {{CollapsibleSection
 |intro = === Collapsible Section ===

@@ 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.
-== 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.
 * 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 ==
 Some awesome content of this higher level
 </pre>
 * 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.
-=== Related links at the end of the page ===
 All tutorials include the tutorials info box at the end of the page using
 <pre>== Links ==
@@ Line 20: / Line 21: @@
 {{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:

← Older revision		Revision as of 19:26, 1 May 2018
Line 11:		Line 11:
	* 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.
		+	=== 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}}

Style Guide - Revision history

Fheubach at 20:42, 1 May 2018

Fheubach at 20:41, 1 May 2018

Fheubach at 19:42, 1 May 2018

Fheubach at 19:41, 1 May 2018

Fheubach at 19:34, 1 May 2018

Fheubach: /* Collapsible Sections */

Fheubach at 19:28, 1 May 2018

Fheubach at 19:26, 1 May 2018

Fheubach: 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 <..."

Fheubach: 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 `<..."`