Document Actions
Working with the Vasudeva Service library repository
This description is specifically for users of the Vasudeva Service library repository. Others might find the svn installation instructions of value, but the rest might be of limited use.
Installing Subversion on Mac
- Download and install Subversion from http://www.codingmonkeys.de/mbo/ : click on the latest version on the right hand side (At the time of writing, it was Subversion 1.4.3.pkg)
- After the download, unpack the file, click the .pkg-installer and install Subversion.
- Go to /Applications/Utilities and click on Terminal (the icon with the black computer screen).
- To test if svn is working properly, type svn and press Enter. If you get an message like Type 'svn help' for usage, then you know the program you just downladed is working correctly. If the svn command is not recognised at first, perhaps it is because the path is not set properly. In that case, type
vi .profile
This will most likely give you a blank screen. Press I (capital I) to insert text, and paste in the following line:
export PATH=$PATH:/usr/local/bin
Then press the Escape key, and then type ZZ to take you back to the prompt. Now close that terminal window and open up a new one. Type svn and Enter again to see if it works now.
Then open another Terminal window and try again with: svn [enter]
If it is working, then we go onto the next step....
Using the Repository
Every book in the repository is located in a folder with four digit number e.g 0001. Each folder will contain the original text file and the reStructured text file for the book.
So suppose we want to work on book number 0001: well, first we want to download the folder to our local computer so we can work on it. Typing the following command in the Terminal screen will create the folder Documents/Books/0001 on your computer and put the contents of the 0001 repository folder inside it:
svn co https://svn.vasudevaserver.net/vs/lib/0001 ~/Documents/Books/0001
You might get a message like this:
Error validating server certificate (blah blah blah) (R)eject, accept (t)emporarily or accept (p)ermanently? p
Press p and Enter to accept permanently. You shouldn't see that message next time you try to access a book on the repository.
Next is to enter the password, which is your MMS password. It might not accept it the first time, because your local username isnt the same as your MMS username. It than will ask you for your username and password again:
Authentication realm: <https://svn.vasudevaserver.net:443> Subversion Password for 'shanemagee': Authentication realm: <https://svn.vasudevaserver.net:443> Subversion Username: shane_magee Password for 'shane_magee':
In the above example my local computer name is shanemagee and my MMS name is shane_magee, but everything went OK the second time:
Checked out revision 1.
So when you go to Documents, you should see the Books folder there, and the 0001 folder inside it. now the next step is to modify the contents....
Modifying the contents
The first thing is to make sure the version of the book you're modifying is the latest one. If the book folder has been on your hard disk for a while, or you know someone else is also working on the same book, you can get the latest version by typing in
svn up ~/Documents/Books/0001
Normally, this shouldn't be necessary.
When you begin, the folder will contain a file with the original book content. We need to add another file with the same content in reStructured Text format. The ReStructured Text file itself is just a simple text file, and should have the suffix .txt.
Instructions on ReStructured Text layout are all explained by clicking this link....
When you have created any new files (0001.txt, let us say) you need to let the repository know:
svn add ~/Documents/Books/0001/0001.txt
This doesn't save the file to the repository, it just makes the repository aware it has to include the file when the saving does happen.
When all is ready, we can then add the changes to the repository:
svn ci ~/Documents/Books/0001 -m "a comment"
We recommend you include a short comment describing the nature of the work done.