Help:Updating the list of changes
The List of changes is divided over separate lists of changes which are all transcluded in the page. Each separate page contains the description of all the changes between two consecutive final releases of Total Commander. So wait for the next final release before adding newer changes.
Whenever a new final version has been released the newest changes can be found at http://www.ghisler.com/history.txt or in the file HISTORY.TXT in Total Commander's installation folder after installing the new version.
Applying corrections to the List of changes
Not only are new changes to Total Commander continuously added to the HISTORY.TXT file, corrections to earlier changes are also made. To find these corrections compare the latest version of the HISTORY.TXT file with an earlier version. Then apply the corrections to the appropriate wiki pages.
Adding to the List of changes
The following sections contain step by step instructions on how to add changes between two consecutive final releases to the List of changes.
Get new changes from HISTORY.TXT
First retrieve the raw data to add to the list.
- Download the latest HISTORY.TXT file and copy it to a different name, for example "HISTORY v10-9.51.TXT".
- In this file, delete all but the changes you want to add to the wiki.
Convert text to wiki format
Now we have to convert the text to the format used on the wiki. This involves adding wiki code to create headers and list items, putting dates between round brackets for readability and preventing text to be interpreted as wiki code. The instructions below assume you use Notepad-plus-plus for editing. You can of course use another Editor.
Here is a visual of the transformation:
TXT format:
dd.mm.yy Release Total Commander nn.nn Final dd.mm.yy Fixed: xx xxxx xxxx xxxx xx xxxxx dd.mm.yy Fixed: xxxx xxxxxxxxxx xxxxx dd.mm.yy Release Total Commander nn.nn Beta n dd.mm.yy Fixed: xxx xxxx xx x xxxx xxxx xx xxxxx dd.mm.yy Fixed: xxxx xxx xx xxxxx xxx xx xxxxxxx xx dd.mm.yy Added: xxxxxx xxx xxxxx xxxxxxx dd.mm.yy Added: xxxxx x xxx xx xxx xxxxxxx dd.mm.yy Fixed: xxxx xxx xx xxxxx xxx xx xxxxxxx xx
Wiki format:
=== (dd.mm.yy) Release Total Commander nn.nn Final === * (dd.mm.yy) Fixed: xx xxxx xxxx xxxx xx xxxxx * (dd.mm.yy) Fixed: xxxx xxxxxxxxxx xxxxx === (dd.mm.yy) Release Total Commander nn.nn Beta n === * (dd.mm.yy) Fixed: xxx xxxx xx x xxxx xxxx xx xxxxx * (dd.mm.yy) Fixed: xxxx xxx xx xxxxx xxx xx xxxxxxx xx * (dd.mm.yy) Added: xxxxxx xxx xxxxx xxxxxxx * (dd.mm.yy) Added: xxxxx x xxx xx xxx xxxxxxx * (dd.mm.yy) Fixed: xxxx xxx xx xxxxx xxx xx xxxxxxx xx
Add wiki code and round brackets to the header lines
Find what: ^(\d\d\.\d\d\.\d\d)(\s+(Re-)?Release\s+Total\s+Commander\s+\d.*) Replace with: === \($1\)$2 === Options Match case: Disabled Wrap around: Enabled Regular expressions: Enabled . matches newlines: Disabled Perform action: Replace All
Add wiki code and round brackets to all lines starting with a date
Make sure you have done the previous step first.
Find what: ^\d\d\.\d\d.\d\d Replace with: * \($&\) Options Match case: N/A Wrap around: Enabled Regular expressions: Enabled . matches newlines: Disabled Perform action: Replace All
Prevent interpretation of HTML entities
In order to prevent interpretation of HTML entities encode all & characters.
Find what: & Replace with: & Options Match whole word only: Disabled Match case: N/A Wrap around: Enabled Normal search mode: Enabled Perform action: Replace All
Prevent interpretation of HTML and wiki tags
In order to prevent interpretation of HTML tags encode all < characters. Make sure you have done the previous step first.
Find what: < Replace with: < Options Match whole word only: Disabled Match case: N/A Wrap around: Enabled Normal search mode: Enabled Perform action: Replace All
Prevent interpretation of wiki code
Prevent interpretation of wiki code for italic and boldface.
Find what: '' Replace with: <nowiki>''</nowiki> Options Match whole word only: Disabled Match case: N/A Wrap around: Enabled Normal search mode: Enabled Perform action: Replace All
Prevent interpretation of wiki code for horizontal line.
Find what: ---- Replace with: <nowiki>----</nowiki> Options Match whole word only: Disabled Match case: N/A Wrap around: Enabled Normal search mode: Enabled Perform action: Replace All
Prevent interpretation of web addresses.
- Search for "://" to find web addresses. If it's a working web address, you can leave it as it is. Otherwise put the web address between a pair of <nowiki> and </nowiki> tags.
Prevent interpretation of new line characters as a space.
- Search for lines not being a header or list item by searching for regular expression: ^[^=*\r\n]
If you find 2 or more such lines together, you must add the <br /> code for each line break.
Add extra wiki code at the top
Add the following code at the top and replace the version numbers with the correct ones.
<noinclude>{{List of changes intro|10.00|10.50}}
[[Category:Lists of changes|10.00 - 10.50]]
{{Transcluded}}
{{TOC noautonum}}
</noinclude>== [[List of changes (version 10.00 - 10.50)]] ==
Create new wiki page and add it to the List of changes
- Put the text on a new wiki page called "List of changes (version 10.00 - 10.50)". (Replace the version numbers with the correct ones.)
- Edit the List of changes and add the code to include the new page. Look at the other lines there to see how to do that.
Make sure there are no errors in the List of changes
- Check if the list is fully loaded. Check if the release of the first version is listed at the bottom.
- Search for "noinclude". If this word is found, there is an error in one of the transcluded pages.
- Search for "nowiki". If this word is found, it is likely that the opening tag <nowiki> is used somewhere instead of the closing tag </nowiki>.