In the JSPWIKI.PROPERTIES file, a number of directories are referred to, and the system creates/uses other subdirectories under this structure.

The following structure is recommended for Wiki deployment:

|-Wiki
|-|-Files
|-|-Log
|-|-Temp
|-|-Attachments
|-|-Configuration
|-|-Custom

All these directories should be protected from outside access, and should only be manipulated through the Wiki interface.

FILES#

This directory contains the Wiki content. Each Wiki "page" is a text (.TXT) file that contains all teh Wiki Markup required to display the text properly.

This directory is identified by the PROPERTIES file parameter setting jspwiki.fileSystemProvider.pageDir.

Once you have made and changes to a page (and are keeping older versions), the previous version is copied to a subfolder from the Page Directory called OLD, and then a folder for each page. The OLD folder, which has subfolders for each page with a history, will have a file for each version, sequentially number, and a file called page.properties.

This file describes the author of each version, the change comment for that version, and the date/time of the last change. It is not to be modified. There will even be a page.properties file for the very first version of a page, containing the name of the original author. Otherwise this page will be identified as having been created by "UnkonwnAuthor"

LOG#

The parameter log4j.appender.FileLog.File usually points to a file and directory within this directory.

Log files are automatically built in this directory, and are also automatically pruned. Other settings within the JSPWIKI.PROPERTIES file control the size of the log file, and how many versions are maintained.

TEMP#

Temporary files used for the manipulation of the wiki are stored here. The Wiki engine will create subfolders for its own purposes and these must not be deleted while the Wiki engine is running, but they can be deleted after it has been shutdown - they will be recreated as needed.

The Temp Directory is identified by the parameter setting jspwiki.workDir .

Of key interest is the subdirectory directory called lucene which contains the search index parameters as generated by the Lucene Search Engine.

information If you wish to re-index the wiki, you can simply delete this directory, and restart the wiki engine.

ATTACHMENTS#

This directory contains any attachments that have been made for any page. This can be PDF files, images, other TXT files or any other type of file.

The Attachments Directory identified by the parameter setting jspwiki.basicAttachmentProvider.storageDir,

The attachment directory has subfolders for each page that has attachments made for it. The folder name will be the same as the page, with a suffix -att (for example, a page called ERD-CM.txt with an attachment would have those attachments in a subfolder called ERD-CM-att).

Within each -att subfolder will be a subdirectory that is the filename of the attachment, with a -dir suffix. For example, If the ERD-CM page (which is contained in the ERD-CM.txt) file, has an attachment called CM10.JPG, there will be a subfolder in the ERD-CM-att folder called CM10-JPG-dir.

Inside the directory for each picture, will be a numerically sequenced file, showing the version number of each attachment, and a file called attachment.properties.

This file describes the author of each version, the change comment for that version, and the date/time of the last change. It is not to be modified. There will even be a attachment.properties file for the very first attachment containing the name of the original author. Otherwise this attachment will be identified as having been created by "UnkonwnAuthor"

CONFIGURATION#

This directory contains the XML files used to manage User and Group membership, and should be managed only through the Wiki interface. While not necxessary to create their own directory, it is recommended so that subsequent updates of the Wiki engine do not reset your user entries.

The parameters in the JSPWIKI.PROPERTIES file that control the placement of these two XML files are jspwiki.xmlGroupDatabaseFile and jspwiki.userdatabase.

CUSTOM#

This directory contains nothing, but would be used in the installation of a new release

---

Notes#

Click to create a new notes page