0 subscribers Search:
last edited 6 years ago by Will

Quick Reference for Using Structured Text

This Wiki uses a form of Structured Text to support easy text formatting of page content. This page provides a guide to some of the most useful Structured Text conventions. For more detailed help, see Text Formatting Rules or Structured Text Guide .

Note: No HTML was used to make this page; it is composed entirely of Structured Text.

Text Formatting

Format

Convention

bold text

                         **bold text**             

italicized text

                         *italicized text*         

underlined text

                         __underlined text_        

code text

                         'code text'               

Paragraph Formatting

Format

Convention

  • bulleted item
  • bulleted item
  • bulleted item
                           - Precede paragraphs with hyphen             

                           * Or an asterisk to create a bulleted list.  

                           * Paragraphs must be double spaced.          
  1. numbered item
  2. numbered item
  3. numbered item
                         1) Precede paragraphs with a number and a      

                         2) closed parenthesis to create numbered lists.

                         3) Paragraphs must be double spaced.           

Heading 1

Indented paragraphs use the heading above

Heading 2

Increase indent = New heading

                           Heading 1                                    

                              Indented paragraphs use the paragraph     
                              above as a heading.                       

                              Heading 2                                 

                                  Increasing the indentation            
                                  creates a lower level heading.        

A double colon:

                    <b>text</b>          

                    (HTML is escaped)    
                          A double colon::                              

                               Followed by an indented paragraph.       
                               Produces a <pre> block.  HTML and STX    
                               are escaped                              
                               <p>text</p>                              

                               The syntax for the examples on this page 
                               are displayed using the '::' convention. 

                               Note that when inserting code in tables, 
                               the pipe delimiter must immediately      
                               follow the double colon.                 
Two hyphens
makes a definition.
                              A paragraph followed by a double hyphen --
                                   Followed by an indented paragraph.   
                                   Produces definition list block.      

                                   Note that unlike the examples above, 
                                   there is no empty line between the   
                                   title and text for a definition list.

Creating Links

Format

Convention

http://www.google.com

                        http://www.google.com                      

                        Anything resembling a link is converted.   

Google

                        "Google":http://www.google.com             

                        Prepending a quoted name and a colon       
                        creates a named link.                      

                        This method can be used to create          
                        relative links on an STX page              

Mail Me

                            "Mail Me":mailto:spammy@spammo.com     

                            The same convention can be used for    
                            mailto, ftp, etc.                      

StructuredText

                            StructuredText                         

                            Concatenated words that match the name 
                            of a Wiki page are converted to a link 
                            to that page.                          

See Structured Text Tables for more information about how to create tables in Structured Text.


full simple minimal   UserOptions ChangeLog   loginhelp
subject:
This is not a forum for resolving Jabberd 2 issues. Post Jabberd 2 specific questions to either the jadmin or jabberd mailing lists.
 

© 2003 Will Kamishlian and Robert Norris

This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike License. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/1.0/ or send a letter to Creative Commons, 559 Nathan Abbott Way, Stanford, California 94305, USA.

Powered by Zope Valid HTML 4.01! Valid CSS! Creative Commons License