home *** CD-ROM | disk | FTP | other *** search
/ RComp HTML Edit Studio for RISC OS / RComp HTML Edit Studio for RISC OS.iso / ZIPS / SITEM.ZIP / HTMLEdit / !Publish / Docs / !Help next >
Encoding:
Text File  |  2001-10-23  |  4.4 KB  |  127 lines
  1. !Publish v2.00 and later
  2. ========================
  3.  
  4. Please note that !Publish is a fairly technical tool, and is probably
  5. not of immediate use to users who are new to web page creation.
  6.  
  7. HTMLEdit allows you to create pages with "dynamic content", that is,
  8. pages which contain references to other files, or variable information
  9. such as version numbers, current date/time etc.  HTMLEdit includes a
  10. "publish" option which will expand this dynamic content, filling it
  11. in to produce a complete page.
  12.  
  13. !Publish is designed to do the same thing, but on a site wide basis.
  14.  
  15.  
  16. Understanding "Dynamic Content"
  17. -------------------------------
  18.  
  19. Although most customers will be using HTMLEdit to build pages, and
  20. will hence have menu options to automate this process, it is worth
  21. briefly describing what we're talking about.
  22.  
  23. The system allows pages to include information which may change on
  24. a regular basis including date, time, version and (most usefully)
  25. shared blocks of text/HTML etc.
  26.  
  27. These "dynamic" bits are included via comments in your HTML, thus
  28. each command is enclosed in <!-- and --> wrappers.
  29.  
  30. The actual dynamic commands themselves each start with an @ sign:
  31.   
  32.   @DATE   this would be replaced by the current date when published
  33.   
  34.   @TIME   this would be replaced by the current time when published
  35.   
  36.   @VERSION    this would prompt you for a version number
  37.   
  38.   @TEXT filename      The file (a RISC OS filename eg. ADFS::4.$.Text)
  39.                       would be inserted when published.
  40.                       
  41.   @RELTEXT filename   As for @TEXT, except that the filename is 
  42.                       given as a UNIX-style (normal HTML style)
  43.                       relative path, rather than an absolute
  44.                       RISC OS-style filename.
  45.                       
  46. So an example might be:
  47.   
  48.   <!-- @TEXT ADFS::4.$.WebSite.Files.MyText -->
  49.   
  50. As you can see, there's nothing magical to this, so you can create
  51. these tags yourself without HTMLEdit, but naturally HTMLEdit simplifies
  52. the process (and can also publish pages itself).
  53.  
  54.  
  55.  
  56. By sharing things across a number of pages, you can rapidly change
  57. things across the whole site just by changing one file.  Since this
  58. is done *before* uploading your pages to your web site, it will work
  59. on all browsers, and all web servers, and your users/customers will
  60. never know you are using the system!
  61.  
  62.  
  63. If you use !Publish 2 with scripts, you can also copy in (and publish
  64. at the same time) directories or files from other parts of your hard
  65. disc, or from a network, thus drawing together work that others are
  66. doing to form the complete web site.
  67.  
  68.  
  69. As we said above, this is not for those taking their first steps in
  70. Web Authoring, but when used correctly !Publish 2 is an extremely
  71. powerful tool, which adds a new level of scope and automation to
  72. the web design process.
  73.  
  74.  
  75.  
  76.  
  77. Getting started
  78. ----------------
  79.  
  80. You can drag an HTML file, a directory of files, or a script onto the
  81. !Publish icon (or double click a script) to do this.
  82.  
  83. Dragging an HTML file will publish it in much the same way HTMLEdit
  84. does.
  85.  
  86. Dragging a directory will cause each file in that directory to be
  87. "published".  For HTML files, this is just as described above.  For
  88. text files, images and archives (zips etc.), the files are copied
  89. in to the destination directory.  The exact behaviour for these files
  90. can be set in the choices.
  91.  
  92. Scripts
  93. -------
  94.  
  95. A script file (type &AB3 aka "PbScript") or text file dragged onto
  96. the icon will be parsed for "in/out pairs", allowing you to publish
  97. a whole site, merging in resources from all over your hard disc to
  98. produce the final site.  The actions applied to each "in file/directory"
  99. are exactly as if you had dragged to the iconbar, making it easy to
  100. include directories full of files for inclusion.
  101.  
  102. A script will have one or more lines, each taking the form:
  103.   
  104.   <source file/directory>  <destination file/directory>
  105.   ad infinitum...
  106.   
  107. Eg.
  108.  
  109.    ADFS::4.$.Work.TempSite ADFS::4.$.Website
  110.    ADFS::4.$.Work.Images.Temp ADFS::4.$.Website.Images
  111.    Etc.
  112.    
  113. A script of type &AB3 can be double clicked on to launch !Publish
  114. (if needed) and run the script.  This makes it easy to build a
  115. script for the whole of each site you maintain.  If you are a
  116. programmer, think of it as a "makefile" for the site.
  117.  
  118. Date and Time format
  119. --------------------
  120.  
  121. The date and time functions use the system variables HTMLEdit$dateformat
  122. and HTMLEdit$timeformat respectively.  These are set in the !Run file,
  123. and allow you to adjust the date and time formats to your own house
  124. style.
  125.    
  126.  
  127.