home *** CD-ROM | disk | FTP | other *** search
/ InterCD 1999 June / june_1999.iso / Bookmarks / Compass / TEMPLATE / Sample.tpl < prev    next >
Encoding:
Text File  |  1999-05-12  |  5.2 KB  |  164 lines
  1. #############################################################################
  2. # Compass Sample Export Template
  3. # Sample.tpl
  4. #
  5. # Blocks:
  6. # =======
  7. #   A template contains several user-defined "blocks."  There are three types
  8. #   of blocks available in Compass v.2.6: MIAN, FOLDERS, and BOOKMARKS.
  9. #
  10. #    A block definition begins with
  11. #   {block_type:block_name}
  12. #   and ends with
  13. #   {/block_type}
  14. #   where block_type is one of the above types and block_name is optional.
  15. #   If block_name is not specified, the block_type will be used as the block_name.
  16. #
  17. #    1. MAIN         - Required.  The main output block.
  18. #                    - If a name is specified, the name will be used as the output file name.
  19. #                    - If no name is specified, the file dialog will pops up.
  20. #                    - For example: {MAIN:C:\123.TXT} will output to C:\123.TXT.
  21. #    2. FOLDERS      - Optional.  Define the format for folders.
  22. #                    - Two options available for FOLDERS block:
  23. #                    - (T): Top level folder only.
  24. #                    - (A): All bookmarks including sub-folders.
  25. #                    - Please see examples below for the use of those options.
  26. #    3. BOOKMARKS    - Optional.  Define the format for bookmarks.
  27. #
  28. #
  29. # Parameters:
  30. # ===========
  31. #   Parameters are surrounded by the dollar signs ($).  There are six built-in
  32. #   general parameters in Compass v.2.6.  Blocks can be accessed, expanded, or evaluated
  33. #   by surrounding the block name with the dollar signs.  For example, $BOOKMARKS$
  34. #   will be expanded according to the format defined in the BOOKMARKS block.
  35. #
  36. #    1. VERSION      - The version of Compass.
  37. #    2. USER         - The registered user name.
  38. #    3. EMAIL        - The email of the registered user.
  39. #    4. SERIAL       - The serial number of the registered copy.
  40. #    5. DATE         - Current date.
  41. #    6. TIME         - Current time.
  42. #    7. COUNT        - Counter for bookmarks or folders.
  43. #
  44. #
  45. # Item data:
  46. # ==========
  47. #   Item data is a special paramters that can be used only inside FOLDERS or
  48. #   BOOKMARKS blocks.  Use dollar signs ($) to access those data.
  49. #
  50. #    1. TITLE
  51. #    2. URL
  52. #    3. FOLDER
  53. #    4. LASTVISIT
  54. #    5. DESCRIPTION
  55. #
  56. #
  57. # Configuration:
  58. # ==============
  59. #   There are two options to control the format of the "description" of bookmark
  60. #   or folder items.  By default, descriptions uses HTML tag <BR> for new lines
  61. #   (to separate two description lines).  Users can change or remove the "new line"
  62. #   by using the following two settings.
  63. #
  64. #   Prefix a percent sign (%) in front of the configuration keyword and use
  65. #   the equal sign (=) to assign values.  For example:
  66. #   %DESC_NEWLINE=YES
  67. #   %DESC_NEWLINE_ADD="   * "
  68. #
  69. #    1. DESC_NEWLINE     - YES/NO to add/remove new line strings.
  70. #    2. DESC_NEWLINE_ADD - The string to be added in front of each new line of description.
  71. #
  72. #############################################################################
  73.  
  74.  
  75. #############################################################################
  76. # Definition for BOOKMARKS & FOLDERS blocks:
  77. #############################################################################
  78.  
  79. {BOOKMARKS}
  80.     $FOLDER$ - $TITLE$
  81. {/BOOKMARKS}
  82.  
  83. {FOLDERS:FOLDER_LIST}
  84.     $FOLDER$$TITLE$
  85. {/FOLDERS}
  86.  
  87. {FOLDERS}
  88. $BOOKMARKS$
  89. {/FOLDERS}
  90.  
  91. {FOLDERS(T):TOP_FOLDERS_ONLY}
  92. ** All Bookmarks in $FOLDER$$TITLE$ (no sub-folers) **
  93. $BOOKMARKS$
  94. {/FOLDERS}
  95.  
  96. {FOLDERS(A):ALL_BOOKMARKS_IN_ALL_FOLDERS}
  97. ** All Bookmarks in $FOLDER$$TITLE# **
  98. $BOOKMARKS$
  99. {/FOLDERS}
  100.  
  101. {FOLDERS(TA):TOP_FOLDERS_AND_ALL_BOOKMARKS}
  102. ** All Bookmarks in $FOLDER$$TITLE$ **
  103. $BOOKMARKS$
  104. {/FOLDERS}
  105.  
  106.  
  107.  
  108. #############################################################################
  109. # The main output file:
  110. #############################################################################
  111.  
  112. {MAIN}
  113. This is an example template to show how the new
  114. "Export Selection with Template" feature works.
  115.  
  116. Please take a look at the template file Samples.tpl
  117. and compare it with the output file to see the output file
  118. was generated.
  119.  
  120. For a complete reference, please see the Help file.
  121.  
  122.  
  123. ******************** Available Built-in General Parameters ********************
  124.  
  125.     1. VERSION  - $VERSION$
  126.     2. USER     - $USER$
  127.     3. EMAIL    - $EMAIL$
  128.     4. SERIAL   - $SERIAL$
  129.     5. DATE     - $DATE$
  130.     6. TIME     - $TIME$
  131.  
  132. ************************* List of All Folders *************************
  133.  
  134. $FOLDER_LIST$
  135.  
  136. ************************* List of All Bookmarks *************************
  137.  
  138. $BOOKMARKS$
  139.  
  140. ************************ The FOLDERS Block with BOOKMARKS ************************
  141.  
  142. $FOLDERS$
  143.  
  144. ************************* The (T) Option in FOLDERS Block *************************
  145.  
  146. $TOP_FOLDERS_ONLY$
  147.  
  148. ************************* The (A) Option in FOLDERS Bolck *************************
  149.  
  150. This will generates lots of outputs.  If you want to see the result, please edit the
  151. template file to replace the equal-sign with the dollar-sign:
  152.  
  153. =ALL_BOOKMARKS_IN_ALL_FOLDERS=
  154.  
  155. ************************* The (TA) Option in FOLDERS Bolck *************************
  156.  
  157. $TOP_FOLDERS_AND_ALL_BOOKMARKS$
  158.  
  159. **************************************************
  160. ** Exported by Compass at ($DATE$ $TIME$)
  161. ** Export Template - Sample.tpl
  162. **************************************************
  163. {/MAIN}
  164.