Rename a Topic File

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

In this tutorial, you'll learn how to rename a file in your collection.

File naming strategies are an integral part of any file based management system and you should take great care in planning your system. The file system information page suggests a few approches you might want to consider.

Whatever choice you make, you'll eventually want to rename one of your files and Tópico makes it easy to do so. Just make sure your file naming system works for you instead of becoming a source of confusion when your collections grow.

To rename a file

  1. Double-click the topic id that is located at the right of the tab labels at the the top of the window;
  2. Enter the new identifier;
  3. Press Enter or click Ok.
Tip

Tópico will rename all language files associated with this id and replace all occurences of links to this topic from within the collection.

Warning

Never rename files that are part of a collection outside of Tópico. File names are in close relationship with the topic id and Tópico will loose trace of the files you rename elsewhere.

Topic title, navigation title and file name

When working with Tópico it will help you to distinguish between a topic's:

  • Navigation title - A title used in the menu
  • Topic title - The actual topic title that will be used to create the topic's main heading
  • File name - The file name is built with the topic ID, to which are appended the language code and file extension.

The image below shows where to look for the above properties in the user interface.

When the check box above the treeview is checked, you can edit the navigation title directly in the treeview. When you edit the navigation title the topic main title is kept in sync if it was originally the same as the navigation title.

Once you've change the topic tile for something different from the navigation title, maybe for something a bit more verbose, changing the navigation title will no longer changes the topic title.

How Tópico works with topic IDs

When you create a new topic in Tópico the source file that is created for this topic is named as follow:

  1. The topic id is used as the base for the file name; (1)
  2. A two letter language suffix is added, preceded by a dot ".";
  3. The xml extension as added to the file.

(1) This topic id is also copied to the id attribute of the topic element in the xml file.

This arrangement allows multilingual collections to be published for small to medium dynamic web site.

Using file names as topic IDs

When you create a new topic file, the input dialog automatically convert your text to a normalised form that is meant to emphasize the fact that file names should be used as some sort of identifier instead of the document's title.

While a full file naming strategy is totally up to you, here are some suggestions you might consider:

  • Use a prefix to distiguish file type
    • You'll be able to recognize them more easily
    • They'll be easier to process if they have to
  • Create file names (ids) from generic to specific
    • They'll group naturally when viewed in Windows Explorer
    • They might even mirror areas of your map in some way
  • Use suffixes to distinguish variations of an original file (.en.xml = English, .fr.xml = French)
    • Tópico uses the two character language code as a suffix on all the files it creates
  • Use the international date format YYYY-MM-DD to enter dates
    • Dates will list in chronological order naturally
    • Your brain will find them easier to compare

Try to create file names that are appropriate "labels" for your topics. A file name does not have to be the "document title". In fact it should't be.

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

24 / 194