forrest-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject cvs commit: xml-forrest/src/documentation/content/xdocs wiki-sample.cwiki
Date Tue, 09 Dec 2003 03:56:27 GMT
crossley    2003/12/08 19:56:27

  Modified:    src/documentation/content/xdocs wiki-sample.cwiki
  Be careful with the hierarchy of Wiki headings. It broke the forrest build.
  Revision  Changes    Path
  1.3       +16 -14    xml-forrest/src/documentation/content/xdocs/wiki-sample.cwiki
  Index: wiki-sample.cwiki
  RCS file: /home/cvs/xml-forrest/src/documentation/content/xdocs/wiki-sample.cwiki,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- wiki-sample.cwiki	10 Jun 2003 10:09:01 -0000	1.2
  +++ wiki-sample.cwiki	9 Dec 2003 03:56:27 -0000	1.3
  @@ -1,12 +1,12 @@
   !!!Forrest's Wiki Support
   Forrest now has partial support for documentation in Wiki format, thanks to the
  -[Chaperon parser|]. Wiki is a simple text format that can
  +[Chaperon parser|]. Wiki is a simple text format that can
   be learned in minutes. This page provides an overview of the syntax that
   Forrest supports, namely a subset of that used by the [Cocoon
  -!Quick reference
  +!!Quick reference
   ----       = Make a horizontal ruler. Extra '-' is ignored.
  @@ -25,6 +25,8 @@
   !heading   = small heading with text 'heading'
   !!heading  = medium heading with text 'heading'
   !!!heading = large heading with text 'heading'
  +Note: Be careful with the hierarchy of headings,
  +e.g. do not jump from level-3 to level-1.
   ''text''   = prints 'text' in italic.
   __text__   = prints 'text' in bold.
  @@ -35,16 +37,16 @@
   ;term:ex   = makes a definition for 'term' with the explanation 'ex'
  -!Writing text
  +!!Writing text
   You don't need to know anything about the Wiki text formatting rules to use
   Wiki.  Just write normal text, and then use an empty line to mark a paragraph.
   It's just like writing an email.
   The link can also be a direct URL starting with http:, ftp:, mailto:, https:, or news:,
in which case the link points to
  -an external entity. For example, to point at the home page, use [[],
which becomes
  -[] or [[Java home page|], which becomes [Java home
  +an external entity. For example, to point at the home page, use [[],
which becomes
  +[] or [[Java home page|], which becomes [Java home
   To add a new page you just create a link to it from somewhere else. After all, there isn't
much point in having a page
   if you can't access it! You'll then see a small question mark after the page name when
you return to that page. Then
  @@ -57,7 +59,7 @@
   should be a link).  It's off by default, but if your friendly administrator has turned
it on, then well, CamelCase all
   you want =).
  -!Adding pictures
  +!!Adding pictures
   For security reasons uploading images is not permitted, but you can embed
   any image in the wiki code by putting the image available somewhere on the web in one of
the allowed formats, and then
  @@ -67,7 +69,7 @@
   If you specify a link text ([[this one here|]) it becomes
   the ALT text for those who either can't or don't want to view images.
  -!Bulleted lists
  +!!Bulleted lists
   Use an asterisk (*) in the first column to make bulleted lists. Use more asterisks for
deeper indentation. For example:
   * One
  @@ -82,7 +84,7 @@
   * Three
   ** Three.One
  -!Numbered lists
  +!!Numbered lists
   Just like with bulleted lists, but use a hash (#) instead of the asterisk. Like this:
   # One
  @@ -108,7 +110,7 @@
     Notice, however, as all these sentences get put inside a single item!
   * The third line is again a single-line item for your convinience.
  -!Definition lists and comments
  +!!Definition lists and comments
   A simple way to make definition lists is to use the ';:' -construct:
  @@ -122,19 +124,19 @@
   Which would be seen as
   ;:''Comment here.''
  -!Text effects
  +!!Text effects
   You may use __bold__ text or ''italic'' text, by using two underscores (_) and two single
quotes ('), respectively. If
   you're on a Windows computer, make sure that you are using the correct quote sign, as there
is one that looks the same,
   but really isn't.
  -!Preformatted text
  +!!Preformatted text
   If you want to add preformatted text (like code) just use three consecutive braces ({)
to open a block, and three
   consecutive braces (}) to close a block. Edit this page for an example.
   You can do simple tables by using using pipe signs ('|').  Use double pipe
   signs to start the heading of a table, and single pipe signs to then

View raw message