Pd Community Site StructuredTextHelp

Basic text formatting ( see originalHelp )

Italicized text
Enter this :
```
         *italics*
```
to get this:

italics
Underlined text
Enter this :
```
         _underline_
```
to get this:

underline
Boldfaced text
Enter this :
```
         **boldface**
```
to get this:

boldface

Headers and paragraphs

Text headers

Enter this:

         My header

            If you enter a single line paragraph (e.g. like the one
         above and then indent the first line of the next paragraph, 
         the text in the one-line paragraph will be transformed into
         a header.

            Note that the second paragraph in the section also has 
         its first line indented.

            Be sure to leave a blank line between paragraphs.  This
         paragraph's first line is indented, too.

To get this:

My header

If you enter a single line paragraph (e.g. like the one above and then indent the first line of the next paragraph, the text in the one-line paragraph will be transformed into a header.

Note that the second paragraph in the section also has its first line indented.

Be sure to leave a blank line between paragraphs. This paragraph's first line is indented, too.

Inlined preformatted text

Enter this:

      Some ordinary text here.  Some 'preformatted text here'.  More ordinary text.

to get this:

Some ordinary text here. Some preformatted text here. More ordinary text.

"Definition" Box

Enter this:

      Lead text::

        This definition box will be shaded (and depending on the skin, it will be a 
color such as blue).  Also, the text inside this box will not be interpreted by Zope or
Plone, so you can put tags and code in it without messing up the display.

to get this:

Lead text:

     This definition box will be shaded (and depending on the skin, it will be a color 
such as blue).  Also, the text inside this box will not be interpreted by Zope or 
Plone, so you can put tags and code in it without messing up the display.

Lists

Bulleted lists

Enter this:

         * First item

         * Second item.  Note that there is a blank line between
         each list item.

            * Make lists within lists by using extra indentation

            * Second indented item.

         * Third item in the main list.

to get this:

First item
Second item. Note that there is a blank line between each list item.
- Make lists within lists by using extra indentation
- Second indented item.
Third item in the main list.

Numbered lists

Enter this:

         1 First item

         2 Second item.  Again, note that there is a blank line 
         between each list item.

         3 Third item in the main list.

to get this:

First item
Second item. Again, note that there is a blank line between each list item.
Third item in the main list.

Note that numbered lists cannot be embedded in bulleted lists.

Definition lists

Enter this:

         First item -- More information about the first item.

         Second item -- More information about the second item.

         Third item -- More information about the third item.

to get this:

First item: More information about the first item.
Second item: More information about the second item.
Third item: More information about the third item.

Links

Links
Enter this:
```
         "A link to CNN":http://www.cnn.com
```
to get this:

A link to CNN

Enter this:
```
         "page in same folder":thename
```
to get a link to another object in the same folder. The name (here as thename) has to be the name of the file; not the title (long description).

Email addresses

Enter this:

         "address@example.com":mailto:address@example.com

to get this:

address@example.com

References

Enter this:

         I am going to refer to a footnote here [1].

         Later in the text I will have a footnotes
         section.

         .. [1] My footnote.

to get this:

I am going to refer to a footnote here [1].

Later in the text I will have a footnotes section.

[1] My footnote.

Note that the footnote must be placed at the start of a line all the way flush left.

Images

Images

Enter this:

         "Text shown when the browser does not load the image":img:logo.jpg

to get this:

You can use an arbitrary URL for the image, e.g.:

         "Plone logo":img:http://www.plone.org/logo.jpg

You can use an arbitrary URL from within plone. For example you want to add a .jpg that is on another members page you would make something like:

         "Photo of a room":img:/Members/MemberJohn/Homepage/Photos/theroom

Where theroom is the name of the object that MemberJohn? had added in his Homepage/Photos folder. So it is not a direct reference to the .jpg file but rather to the added object in the folder.

Image names should be one word, using an "_" or "-" in the name of the image, for example "image-name" will prevent you from being able to insert the image into the page. The "_" for example is mentioned above and is used to indicate that the word should be underlined.

A Photo will be shown entirely; no sizing is possible. Of an image you can set the size (which is an attribute of an image, not of a photo). That means you want to use an image and not photo to place a photo if the photosize (pixels) is too large to show comfortably.

Tables

Tables

Enter this:

      |------------------------------------|
      | Fruit     | Nut        | Mammal    |
      |====================================|
      | Apple     | Peanut     | Squirrel  |
      |------------------------------------|
      | Orange    | Macadamia  | Woodchuck |
      |------------------------------------|
      | Banana    | Walnut     | Dolphin   |
      |------------------------------------|
      | This spans 2 columns!  | Cat       |
      |------------------------------------|
      | Pear      | This spans 2 columns!  |
      |------------------------------------|
      | This spans 3 columns!              |
      |------------------------------------|

to get this:

Fruit	Nut		Mammal
Apple	Peanut		Squirrel
Orange	Macadamia		Woodchuck
Banana	Walnut		Dolphin
This spans 2 columns!		Cat
Pear	This spans 2 columns!
This spans 3 columns!

see the source of this code: UsingStructuredTextCode