Some more files I forgot.
[mspang/www.git] / docs / editing-howto.xml
1 <?xml version='1.0'?>
2
3 <!DOCTYPE cscpage SYSTEM "../csc.dtd">
4
5 <cscpage title="CSC Website Editing Howto">
6   <header/>
7   <section title="Getting started">
8     <p>
9       In order to edit the website you will first have to get the CVS
10       repository in which it is stored. To do so, go somewhere in your
11       home directory and type:
12     </p>
13     <code>
14       export CVS_RSH=ssh<br />
15       cvs -d username@peri.uwaterloo.ca:~sjdutoit/cvsroot co www
16     </code>
17     <p>
18       Where <code>username</code> is your CSC user name. You will be
19       prompted for your password (unless you use an SSH key). After a
20       while you should have a new directory, <code>www/</code>, with
21       the CSC pages in it.
22     </p>
23     <p>
24       You will also need <code>libxslt</code> and <code>libxml</code>
25       (including development headers) from Gnome. In debian,
26       <code>apt-get install libxml2-dev libxslt1-dev</code>.
27     </p>
28   </section>
29   <section title="Compiling the website">
30     <p>
31       The CSC website is <i>compiled</i>. This means that when you
32       edit a page, you don't edit the HTML source directly, but
33       instead edit a page describing the page's <i>content</i> (and
34       some formatting) and then run a command to generate the HTML
35       page from these content description pages.
36     </p>
37     <p>
38       To generate the CSC website, make sure you are in the directory
39       into which you checked it out (the <code>www/</code> directory)
40       and enter
41     </p>
42     <code>
43       make
44     </code>
45     <p>
46       This will compile the whole website. After any changes you make
47       you will have to recompile the website in the same manner.
48     </p>
49   </section>
50   <footer />
51 </cscpage>