These instructions apply when you will be downloading the development version to your own PC which is set up as a server for purposes of developing. Windows and MAC PCs can also be set up as servers when the necessary server programs (Apache, MySQL, PHP, etc.) are installed either individually or packaged together (see this Wikipedia page for a list of such packages).
There are other combinations of software that can be used as well - see Create an IDE for documentation on some configurations.
Here's an overview of the steps for committing when using your PC as a server:
- Use a third-party SVN program to check out the development version you want to change onto your PC
- Use a third-party code editor to make the code changes you want to make and save them
- Use a third-party SVN program to check your changes
- Test your the Tiki install that you just changed to see if it functions
- Use a third-party SVN program to commit your changes
These steps are described in detail below.
Checking out means you are downloading the files to your PC under a third-party SVN program that keeps track of all changes that are made.
Below, assume that we found a bug in the last_mod plugin and therefore want to change the
lib/wiki-plugins/wikiplugin_lastmod.php file. Assume that we've decided to change Branch 7.x after looking at Where to commit.
- Open Windows Explorer and right-click on an empty folder where you would like the development version to be downloaded into and select "SVN Checkout...".
In this example, the folder is called
- In the pop-up, type in the following as the URL of the repository:
http://svn.code.sf.net/p/tikiwiki/code/7.x, as shown in this screenshot:
- After clicking OK, the pop-up will show the files being downloaded and will indicate when the download is complete as shown in this screenshot:
- Make changes to the file you wish to fix using a third party code editor.
Warning - File settingsAny files you change should be saved with "LF" as the line break characters (Unix-style), not CR + LF as used in Windows. These characters are usually hidden so use a "show all characters" type option or look in the settings or preferences to make sure the line breaks are Unix-style.
Also, make sure the settings are set to encode documents with UTF-8 without BOM (the "without BOM" is important).
In our example, lib/wiki-plugins/wikiplugin_lastmod.php is being changed. After the change is saved, the changed status is indicated by the red color (the green color on the other folders and file icons show that the files were downloaded using the SVN program):
- In TortoiseSVN, this is done by right clicking the
tikisvnfolder and selecting "SVN Commit..." from the menu (even though you're not committing yet!). The following pop-up will appear:
- Double click the file name shown in the above pop up to see the following record of changes made:
- Check to see that these are the changes you intended
- If you haven't already, install the developer version you have downloaded and changed by following the normal Installation procedures through an internet browser.
- Once installed, test Tiki to ensure that your changes work properly.
- Type a description of the change you have made in the Commit pop-up that was brought up in the first part of Step 3 above and click OK. (If the pop-up is closed, right-click the
tikisvnfolder and select "SVN Commit..." from the menu to open it again.)
The following tags can be used to distinguish changes:
In the case of a "backport," (committing a change already made in trunk to an earlier version), a backport reference should be added in front. For example,
[bp/r28500] [FIX]...in a commit message to the branch branches/5x, means this fix is a backport of trunk revision 28500 to the next version of Tiki 5x. Depending on the period, backports are subject to an extra level of review so please read Quality Team and Where to commit first or ask on the mailing list or IRC if unsure.
Here's a screenshot showing the description filled in:
CommentNote that the Commit pop-up was brought up by right-clicking on the tikisvn folder and not on the actual file that was changed. There is no need to right-click the files that are actually changed - right-clicking the top-level tiki folder will bring up only the files that have been changed for the commit.
- Enter your SourceForge username and password when prompted
- The SVN program will notify you when the commit is completed and successful
Tiki is the collective work of hundreds of people. It works because of volunteers, like you, take the time to make it better.
Notice of your commit will appear in the Tiki IRC chat channel. Go here to see it in the logs or, better yet, log on to the actual chat channel just before you commit and see the notice pop up live!