projects:tmwiki:tutorial

TMwiki tutorial

== Level 5 Headline - * Ordered List Item ==

Edit topics and association

Working with TMwiki is very easy. To edit a topic node just click the edit button on the left side of the Topic Map browser. To edit an association click on the edit link in the association list at the bottom of the page.

After clicking the edit button you see the wiki page editor screen where you can edit directly the XML content of the node. Currently all information are stored only in Topic Map XTM syntax version 1.0.

TMwiki provides some help for the editing process because the XTM syntax is not very handy. In the upper area of the editing screen several tool buttons are displayed. If the user clicks on a button the XML code of the Topic Map element will be inserted in the editing field. These simplifies the authoring in the XTM-syntax.

For example, if you want to insert a “baseName” element just click the BN button and the following code is inserted:

<baseName>
   <baseNameString>Base Name</baseNameString>
</baseName>

Afterwards just insert your chosen “baseName” between the <baseNameString> tags. The following table gives you an overview of the available Topic Map tool buttons.

topic node editing association node editing
symbol description symbol description
inserts code for a baseName elementinserts code for a instanceOf element
inserts for a instanceOf elementinserts code for a scope element
inserts code for a scope elementinserts code for a member element
inserts code for a ressouceData occurrence elementinserts code for a roleSpec element
inserts code for a referenceRef occurrence element--
inserts code for a subject identity element--

Finish the editing by clicking on the save button at the bottom of the page. If you don’t want to save click on the cancel button.

Only if the code is well-formed and valid to the XTM version=1.0 DTD it can be saved. If a error occurs a message will be displayed in the upper field of the editing screen.

Additional you can insert an edit summery about your changes. These summaries will not be saved in the Topic Map. These information are only visible in the older revisions overview page and will help other users to understand your changes.

After saving you jump automatically back to the current node in the Topic Map browser. If you have edited an association you jump back to a screen where you can select a member topic of the association.

Adding new topics and associations

To add a new topic or an association simply type the id of the new node in the text field in the Authoring Tools of the Topic Map Browser.

Afterwards the id will be checked. The following name restrictions occur because of the underlining dokuwiki engine:

  1. No blanks are allowed in the id
  2. Only lower characters are allowed
  3. The id must be unique in the current Topic Map.



The TMWiki system is checking the restrictions and is returning an error code if something went wrong. If everything is fine a link is displayed to create the new node. The link brings you to the TMwiki editor screen where you can insert the data.

Hint: It is useful to give at least every topic a basename.

Versioning system

The features of the used wiki engines provides TMwiki with a powerful versioning system. Every change of the Topic Map is saved and therefore users can easily jump back to an older version.

To view the older versions click on the editing screen on the button Old revisions. This brings you to an overview page where every old version is listed including the dates of change. To switch back to an older version select it from the list by clicking on the green link. This brings you to an edit screen where the content of the old version is displayed. To switch back just save this page by clicking the save button.

If you click on the coloured sun glasses button on the overview page you will come to a page that shows the differences between the selected revision and the current version.

Example:












TMwiki RSS-feed

The best way to keep track on the latest chances of a Topic Map is to use the TMwiki RSS feed. RSS (an acronym for “Rich Site Summary” and later coined “Really Simple Syndication”) is a way for web sites to summarize their content, such as news articles, to make it available in a different view.

If you surf with the firefox browser on the Internet its very easy to use rss-feed. Firebox provides Live Bookmarks that let you view RSS directly in the bookmarks toolbar or in the bookmark menu. With one glance, quickly see the latest changes of Topic Maps or wiki pages.

Generally a site is enabled for Live Bookmarks when you see this icon on the bottom right corner of the browser. Clicking on the icon and selecting an RSS feed will bring up the “Add Bookmark “dialog. Select ‘OK’ and you will see Live Bookmarks with the rest of your bookmarks. more information about firefox live bookmarks ...

To view the recent changes you can alternatively click in head line of TMwiki on the Recent Changes button.


Back to TMwiki project page

 
projects/tmwiki/tutorial.txt · Last modified: 2007/07/23 15:38 by 220.227.242.213