Participate

Welcome! Arduino wants you ;) !
Here you will learn all there is to know about how to contribute to this playground wiki. For tracking and security reasons you will have to sign up for an account in order to edit the pages.

Formatting Suggestions

Here are some guidelines for when you add information to the wiki. These are not coming from a place of authority, so if you feel you know a better way, please change these guidelines!

Titles

You type You get
! Page Title
!! Major Title
!!! Minor Title
!!!! And More Titles

Page Title

Major Title

Minor Title

And More Titles

You can use 1 to 4 exclamation points to change the headings size.

Layout

If useful, make a Navigation section and use anchors where suited.

You type You get
 
! Navigation
* [[#MyTitle|My Title]]
* [[#MyOtherTitle|My Other Title]]

! [[#MyTitle]]My Title
My content 

! [[#MyOtherTitle]]My Other Title
My other \\
multiline \\
content.

Navigation

My Title

My content

My Other Title

My other
multiline
content.

Source Code

You can put code into the playground with special formating if you want. This is via the SourceBlock plugin, a pmWiki wrapper for GeSHi. Read more at those links, but here is a quick reference to optional PARAMETERS:

  • lang=LANGUAGE to select one of the supported highlighters,
  • linenum{=START_NUMBER} to enable line numbers and optionally specify start value.
  • tabwidth=TAB_WIDTH to set the number of spaces to use for tab replacement(*).
  • header=TEXT and footer=TEXT to surround the source code(*).
  • highlight='LINE_NUMBER1, LINE_NUMBER2,...' to specify the line numbers to point-out (separators are spaces, comma and semicolon).
  • -trim to disable the automatic trimming of source.
  • -link to disable the automatic generation of documentation links(*).
  • -getcode to disable the "Get Code" view/download code link (see below).

You type You get

(:source lang=c linenum:)
/*
Mr. Roboto
December, 2007

This is the most important software ever written
*/

Serial.println("Hello World. I am Mr. Robot.");
(:sourceend:)

  1. /*
  2. Mr. Roboto
  3. December, 2007
  4.  
  5. This is the most important software ever written
  6. */
  7.  
  8. Serial.println("Hello World.  I am Mr. Robot.");

Structure

In general, pages use the ! character for making separators between main and sub topics. If you are adding content to a sub-area and that area gets large (use judgement), it is probably time to create a sub page and add a link from the original location. This keeps the main wiki pages (that are listed in the side bar) from getting gigantic.

Every page in the Arduino Playground should be (?) in one of the following PmWiki groups ( WikiGroup of pages ):

FIXME: do we really need so many groups? FIXME: add a brief summary of each group of pages. Or if there is some other place that summarizes each group, link to that place. (The above links go to the "local" recent changes in each group).

Each group should (?) have a "HomePage". The HomePage summarizes what each group is about, and links to the top pages of that group.

Share