Table of Contents
ChangeLog in this context relates to a plain text file recording the changes done to a project. Usually the developer(s) do this manually, or it is retrieved automatically e.g. from the SVN repository change recordings.
The format of a ChangeLog usable by HistView is best described by an example:
$Id: histview.hist,v 1.19 2007-08-21 17:26:58 izzy Exp $ History for HistView ==================== v0.1.5 ------------------- + added doc/stats.txt to get you started with download statistics if you want them * updated filelist.css + added api reference for the download class v0.1.4 (17.08.2007) ------------------- + added the download class, which provides scanning of directories for downloadable files and creating links for them - or send a given file to the visitor requesting it, while optionally recording the download in a MySQL database + modified the histview class to (optionally) use the download class * modified the img tags to conform w3c + added the possibility to chose a different URL argument separator
Changes are recorded grouped by version. Each versions block starts with the version number, which must have the "v" as the first letter - followed by the version number itself. All lines before the first version number are ignored by HistView - so you can add some hints there for "human readers" of the plain text file.
The first character of each line we may call "mark". Pre-defined marks include:
|+||indicates a new feature|
|-||indicates that something has been removed|
|!||indicates a bugfix|
|*||indicates some change|
Spaces are counted as "continuation" of the previous line, as you may already have guessed correctly. With the add_mark() method, you can add your personal additional marks or change the icons assigned to the default marks using the set_mark method.