sample.aap | searchcode

/samples/sample.aap

http://txt2tags.googlecode.com/ · Unknown · 480 lines · 300 code · 180 blank · 0 comment · 0 complexity · 88348f090f21d624fc108df051a3a231 MD5 · raw file

================================================================================



                              +-----------------+                               
                              | TXT2TAGS SAMPLE |                               
                              +-----------------+                               



                               +----------------+                               
                               | Aurelio Jargas |                               
                               +----------------+                               



                                 +------------+                                 
                                 | 04/08/2012 |                                 
                                 +------------+                                 




================================================================================
================================================================================
 TXT2TAGS SAMPLE                                                           1/19 
                                TXT2TAGS SAMPLE                                 
 Aurelio Jargas                                                      04/08/2012 
================================================================================


 This text is before the introduction.

 But it's OK.













================================================================================
================================================================================
 TXT2TAGS SAMPLE                                                           2/19 
                                  Introduction                                  
 Aurelio Jargas                                                      04/08/2012 
================================================================================

 Welcome to the txt2tags sample file.

 Here you have examples and a brief explanation of all
 marks.

 The first 3 lines of the this file are used as headers,
 on the following format:

  line1: document title
  line2: author name, email
  line3: date, version

 Lines with balanced equal signs = around are titles.




================================================================================
================================================================================
 TXT2TAGS SAMPLE                                                           3/19 
                             Fonts and Beautifiers                              
 Aurelio Jargas                                                      04/08/2012 
================================================================================

 We have two sets of fonts:

 The NORMAL type that can be improved with beautifiers.

 The TYPEWRITER type that uses monospaced font for
 pre-formatted text.

 We will now enter on a subtitle...


 Beautifiers
 ===========

 The text marks for beautifiers are simple, just as you
 type on a plain text email message.


--------------------------------------------------------------------------------
================================================================================
 TXT2TAGS SAMPLE                                                           4/19 
                             Fonts and Beautifiers                              
 Aurelio Jargas                                                      04/08/2012 
================================================================================

 We use double *, /, - and _ to represent *bold*,
 /italic/, -strike- and _underline_.

 The */bold italic/* style is also supported as a
 combination.


 Pre-Formatted Text
 ==================

 We can put a code sample or other pre-formatted text:

    here    is     pre-formatted
  //marks// are  **not**  ``interpreted``



--------------------------------------------------------------------------------
================================================================================
 TXT2TAGS SAMPLE                                                           5/19 
                             Fonts and Beautifiers                              
 Aurelio Jargas                                                      04/08/2012 
================================================================================

 And also, it's easy to put a one line pre-formatted
 text:

  prompt$ ls /etc

 Or use pre-formatted inside sentences.


 More Cosmetics
 ==============

 Special entities like email (duh@somewhere.com) and
 URL (http://www.duh.com) are detected automagically,
 as long as the horizontal line:

 ------------------------------------------------------------------------------

--------------------------------------------------------------------------------
================================================================================
 TXT2TAGS SAMPLE                                                           6/19 
                             Fonts and Beautifiers                              
 Aurelio Jargas                                                      04/08/2012 
================================================================================

 ^ thin or large v

 ==============================================================================

 You can also specify an explicit link (http://duh.org)
 or an explicit email (duh@somewhere.com) with label.

 And remember,









--------------------------------------------------------------------------------
================================================================================
 TXT2TAGS SAMPLE                                                           7/19 
                             Fonts and Beautifiers                              
 Aurelio Jargas                                                      04/08/2012 
================================================================================

                +----------------------------------------------+               
                | A TAB in front of the line does a quotation. |               
                +----------------------------------------------+               

                    +-------------------------------------+                    
                    | More TABs, more depth (if allowed). |                    
                    +-------------------------------------+                    


 Nice.







================================================================================
================================================================================
 TXT2TAGS SAMPLE                                                           8/19 
                                     Lists                                      
 Aurelio Jargas                                                      04/08/2012 
================================================================================

 A list of items is natural, just putting a *dash* or
 a *plus* at the beginning of the line.


 Plain List
 ==========

 The dash is the default list identifier. For sublists,
 just add *spaces* at the beginning of the line. More
 spaces, more sublists.







--------------------------------------------------------------------------------
================================================================================
 TXT2TAGS SAMPLE                                                           9/19 
                                     Lists                                      
 Aurelio Jargas                                                      04/08/2012 
================================================================================

                        +------------------------------+                       
                        | * Earth                      |                       
                        |   * America                  |                       
                        |     * South America          |                       
                        |       * Brazil               |                       
                        |         * How deep can I go? |                       
                        |   * Europe                   |                       
                        |     * Lots of countries      |                       
                        | * Mars                       |                       
                        |   * Who knows?               |                       
                        +------------------------------+                       

 The list ends with *two* consecutive blank lines.


 Numbered List
 =============
--------------------------------------------------------------------------------
================================================================================
 TXT2TAGS SAMPLE                                                          10/19 
                                     Lists                                      
 Aurelio Jargas                                                      04/08/2012 
================================================================================


 The same rules as the plain list, just a different
 identifier (plus).

                           +-----------------------+                           
                           | 1. one                |                           
                           | 2. two                |                           
                           | 3. three              |                           
                           |   * mixed lists!      |                           
                           |   * what a mess       |                           
                           |     1. counting again |                           
                           |     2. ...            |                           
                           | 4. four               |                           
                           +-----------------------+                           

 Definition List
 ===============
--------------------------------------------------------------------------------
================================================================================
 TXT2TAGS SAMPLE                                                          11/19 
                                     Lists                                      
 Aurelio Jargas                                                      04/08/2012 
================================================================================


 The definition list identifier is a colon, followed by
 the term. The term contents is placed on the next line.

                           +------------------------+                          
                           | orange                 |                          
                           |   a yellow fruit       |                          
                           | apple                  |                          
                           |   a green or red fruit |                          
                           | other fruits           |                          
                           |   * wee!               |                          
                           |   * mixing lists       |                          
                           |     1. again!          |                          
                           |     2. and again!      |                          
                           +------------------------+                          


================================================================================
================================================================================
 TXT2TAGS SAMPLE                                                          12/19 
                                     Tables                                     
 Aurelio Jargas                                                      04/08/2012 
================================================================================


 Use pipes to compose table rows and cells.
 Double pipe at the line beginning starts a heading row.
 Natural spaces specify each cell alignment.

                    +-----------+-------------+------------+                    
                    | cell 1.1  |  cell 1.2   |   cell 1.3 |                    
                    +-----------+-------------+------------+                    
                    | cell 2.1  |  cell 2.2   |   cell 2.3 |                    
                    +-----------+-------------+------------+                    
                    | cell 3.1  |  cell 3.2   |   cell 3.3 |                    
                    +-----------+-------------+------------+                    





--------------------------------------------------------------------------------
================================================================================
 TXT2TAGS SAMPLE                                                          13/19 
                                     Tables                                     
 Aurelio Jargas                                                      04/08/2012 
================================================================================

  +-----------+-------------+------------+
  | heading 1 |  heading 2  |  heading 3 |
  +===========+=============+============+
  | cell 1.1  |  cell 1.2   |   cell 1.3 |
  +-----------+-------------+------------+
  | cell 2.1  |  cell 2.2   |   cell 2.3 |
  +-----------+-------------+------------+

                    +-----------+-------------+------------+                    
                    | heading 1 $  cell 1.1   |   cell 1.2 |                    
                    +-----------+-------------+------------+                    
                    | heading 2 $  cell 2.1   |   cell 2.2 |                    
                    +-----------+-------------+------------+                    
                    | heading 3 $  cell 3.1   |   cell 3.2 |                    
                    +-----------+-------------+------------+                    


--------------------------------------------------------------------------------
================================================================================
 TXT2TAGS SAMPLE                                                          14/19 
                                     Tables                                     
 Aurelio Jargas                                                      04/08/2012 
================================================================================

  +-----------+-------------+------------+
  | heading   $  heading 1  |  heading 2 |
  +===========+=============+============+
  | heading 1 $  cell 1.1   |   cell 1.2 |
  +-----------+-------------+------------+
  | heading 2 $  cell 2.1   |   cell 2.2 |
  +-----------+-------------+------------+

 Without the last pipe, no border:

                    +-----------+-------------+------------+                    
                    | cell 1.1  |  cell 1.2   |   cell 1.3 |                    
                    | cell 2.1  |  cell 2.2   |   cell 2.3 |                    
                    | cell 3.1  |  cell 3.2   |   cell 3.3 |                    
                    +-----------+-------------+------------+                    


--------------------------------------------------------------------------------
================================================================================
 TXT2TAGS SAMPLE                                                          15/19 
                                     Tables                                     
 Aurelio Jargas                                                      04/08/2012 
================================================================================

  +-----------+-------------+------------+
  | heading 1 |  heading 2  |  heading 3 |
  +-----------+-------------+------------+
  | cell 1.1  |  cell 1.2   |   cell 1.3 |
  | cell 2.1  |  cell 2.2   |   cell 2.3 |
  +-----------+-------------+------------+

                    +-----------+-------------+------------+                    
                    | heading 1 $  cell 1.1   |   cell 1.2 |                    
                    | heading 2 $  cell 2.1   |   cell 2.2 |                    
                    | heading 3 $  cell 3.1   |   cell 3.2 |                    
                    +-----------+-------------+------------+                    





--------------------------------------------------------------------------------
================================================================================
 TXT2TAGS SAMPLE                                                          16/19 
                                     Tables                                     
 Aurelio Jargas                                                      04/08/2012 
================================================================================

  +-----------+-------------+------------+
  | heading   $  heading 1  |  heading 2 |
  +-----------+-------------+------------+
  | heading 1 $  cell 1.1   |   cell 1.2 |
  | heading 2 $  cell 2.1   |   cell 2.2 |
  +-----------+-------------+------------+











================================================================================
================================================================================
 TXT2TAGS SAMPLE                                                          17/19 
                                Special Entities                                
 Aurelio Jargas                                                      04/08/2012 
================================================================================

 Because things were too simple.


 Images
 ======

 The image mark is as simple as it can be: [filename].

                       [img/photo.jpg]

 And with some targets the image is linkable :

                       (img/photo.jpg) (http://www.txt2tags.org)




--------------------------------------------------------------------------------
================================================================================
 TXT2TAGS SAMPLE                                                          18/19 
                                Special Entities                                
 Aurelio Jargas                                                      04/08/2012 
================================================================================

           +-------------------------------------------------------+           
           | * The filename must end in PNG, JPG, GIF, or similar. |           
           | * No spaces inside the brackets!                      |           
           +-------------------------------------------------------+           

 Other
 =====

 When the target needs, special chars like <, > and &
 are escaped.

 The handy %%date macro expands to the current date.

 So today is 20120408 on the ISO YYYYMMDD format.



--------------------------------------------------------------------------------
================================================================================
 TXT2TAGS SAMPLE                                                          19/19 
                                Special Entities                                
 Aurelio Jargas                                                      04/08/2012 
================================================================================

 You can also specify the date format with the %? flags,
 as %%date(%m-%d-%Y) which gives: 04-08-2012.

 That's all for now.

 ------------------------------------------------------------------------------

 [img/t2tpowered.png] (sample.t2t (sample.t2t))









================================================================================