HintsAndTips

From Pickwiki
Jump to: navigation, search

HomePage>>HintsAndTips

0) At the bottom of every page is a link "Edit Text of this Page". Click this link to, you guessed it, edit the text of the current page. To avoid wiki spam, you now have to login to PickWiki before doing this - see CanBeEdited.

1) Making a new page

  • To make a new page, run two or more words together and capitalize the first letter of each word,
  • or you can put [[around the words]] - the words will then have a ? link in the generated page.
  • If you want the user to see the link described differently from the page entry name then you can put a description after the page name separated by a vertical bar : [[PrimeInformation|Prime Information]]. The link will now contain a space, but the page name will not.
  • After the page has been saved, click on the ? link to start editing the new page.

2) If you post source code, surround it with PRE tags to keep the wiki from making a link out of every class and variable name. Watch out for trailing "\" characters at the end of lines. Even within a <PRE> section this appears to escape the end of line character and smush lines together.

  E=\!sudo shutdown -h now \
  PRINT "Are you sure you want to shutdown?"

VS.

  E=\!sudo shutdown -h now \;
  PRINT "Are you sure you want to shutdown?"


3) Some formatting hints:

  • To make a bulleted list, start a line with a "*" character
  • To make a numbered list, start a line with a "#" character
  • To indent a line, start with a ":" character (more :'s indent more)
  • To draw a line enter ---- (four hyphens)
  • <b> and <i> work just like they do in html
  • = Heading = makes up a heading format.

For more details see: Text Formatting Rules

4) Formatted source code tends to be a dead-end, so put a link like 'Back to JavaSource' at the top of the page.

Some people even impose structure on a page, by listing the most likely set of links used to reach the page at the top. This becomes more useful as a wiki grows beyond two levels deep :-)
For example, you could put this at the top of a page:
HomePage>>HintsAndTips>>FormatTips

5) Clicking on the link at the top of every page that matches the page title, will give a reverse index - a list of all pages that link to this one.

6) To include an external url, either just put it in the text, or you can create a link by putting the url in single square brackets. A description to go in the link can go after the url separated by a space -
[http://www.usemod.com/cgi-bin/wiki.pl?TextFormattingRules Text Formatting Rules]