Collection Files and Folders

THESE PAGES ARE STILL UNDER CONSTRUCTION AND DO NOT NECESSARELY REFLECT THE CURRENT VERSION OF TÓPICO

The collection folder structure is the home of your publication. This is the place where you should copy your image files for publishing, the place where your source files are saved and much of everything related to your publication resides. Here's the basic structure of a collection's main folder.

  • root
    • backup
    • offline
      • html
      • images
      • xml
    • online
      • images
      • scripts
      • styles
      • xml
      • xsl
    • scripts
    • xml

Let's look more closely at each folder.

root

In the above tree, the root folder is the folder where your master file is located. This folder also contains :

 
File Name Description
topico_*.xml The master file for the collection
page.xml The default page that is used as a template when creating new pages within a collection. A dialog box might offer other templates.
styles.html.xml A list of standard XHTML/HTML styles to fill the XStandard styles drop down list (the default list)
styles.custom.xml A list of custom styles to fill the XStandard styles drop down list
insert.xml A list of small xml content snippets (defined by advanced authors or developers). This content can be inserted through the Insert button above the editor.
content.xml The reusable text content defined by the author. This content is edited through a table on the Advanced tab and inserted using a drop downlist above the editor.

root/backup

As a safety measure, every time you click on on the save button, a backup of the master file is created in this folder. A maximum of 21 files is kept in this folder in the long run but all the versions saved on the same day will accumulate.

As an example, lets say you saved your master files 55 times today. There will be 55 files in this folder until the end of the day. The next time you click on the Save button, the first 34 files of the day before will be deleted and 21 files will be left in this folder. At this point these would be 1 saved today and 33 the day before. The number of files will then stay at 21 until you save for the 22st time on the same day.

root/offline

This is the place to store all your original source files (Photoshop, Illustrator, 3D, ...) used to build the site. You can structure this folder as you wish since Tópico only requires the root and online folders. It might even be a good idea to move your other offline files out of the branch to facilitate backing up your projects. While a 500 pages xml markup might be only a few megabytes, media "source" files can get very huge. Images used in a web publication are often much smaller than the "source" files they originate from.

The only exception to the above is the use of the offline/xml and offline/html folders which are used to export an HTML version of single topics.

root/online

This is where all the html pages are published. This is the folder that you upload to your web server (along with it's sub folders), or that you copy onto a CD-ROM.

Tip

Note : When integrating Tópico into a dynamic solution, the online folder would be the root of the web application and no HTML files would be publised. See Setting up a dynamic web site for details.

root/online/images

This is where you should place your image files.

root/online/scripts

This is where scripts are copied when you select a publishing package. All templates also reference this folder from the html files published in the online folder. This folder can be changed through the Foders and URLs button.

root/online/styles

This is where stylesheets are copied when you select a publishing package. All templates also reference this folder from the html files published in the online folder. This folder can be changed through the Foders and Urls button.

root/online/xml

All the source topic files are published in the this folder. Learn more about the publishing process.

root/online/xsl

This is where templates are copied when you select a publishing package. Tópico references this folder, along with the online folder in the transformation process. This folder can be changed through the Foders and Urls button.

THESE PAGES ARE STILL UNDER CONSTRUCTION AND DO NOT NECESSARELY REFLECT THE CURRENT VERSION OF TÓPICO

Back
166 / 194