From d266c39c1b6be2ee022efd1140e2a1767bb1ebaf Mon Sep 17 00:00:00 2001
From: David Bartley <dtbartle@csclub.uwaterloo.ca>
Date: Mon, 20 Aug 2007 19:19:48 -0400
Subject: [PATCH] Removed website documentation. * Docs are outdated and partly
 incorrect. * Website information should go in the wiki.

---
 docs/Makefile                               |   7 +-
 docs/directory.xml                          |   1 -
 docs/editing-example1/Makefile              |   3 -
 docs/editing-example1/directory.xml         |   8 -
 docs/editing-example1/operating-systems.xml |   6 -
 docs/editing-example2/Makefile              |   3 -
 docs/editing-example2/directory.xml         |   9 -
 docs/editing-example2/operating-systems.xml |   6 -
 docs/editing-example3/Makefile              |   3 -
 docs/editing-example3/directory.xml         |   9 -
 docs/editing-example3/operating-systems.xml |  13 --
 docs/editing-howto.xml                      | 190 --------------------
 docs/index.xml                              |   1 -
 docs/website.xml                            |   4 -
 14 files changed, 3 insertions(+), 260 deletions(-)
 delete mode 100644 docs/editing-example1/Makefile
 delete mode 100644 docs/editing-example1/directory.xml
 delete mode 100644 docs/editing-example1/operating-systems.xml
 delete mode 100644 docs/editing-example2/Makefile
 delete mode 100644 docs/editing-example2/directory.xml
 delete mode 100644 docs/editing-example2/operating-systems.xml
 delete mode 100644 docs/editing-example3/Makefile
 delete mode 100644 docs/editing-example3/directory.xml
 delete mode 100644 docs/editing-example3/operating-systems.xml
 delete mode 100644 docs/editing-howto.xml

diff --git a/docs/Makefile b/docs/Makefile
index ca60402..84be125 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -1,7 +1,6 @@
-SUBDIRS = editing-example1 editing-example2 editing-example3 execmanual \
-	procedure
+SUBDIRS = execmanual procedure
 INPUTS = index.xml constitution.xml official.xml machine_usage.xml \
-	machine_usage_summary.xml website.xml editing-howto.xml \
-	constitution-change-20020920.xml execmanual.xml procedure.xml
+	machine_usage_summary.xml website.xml constitution-change-20020920.xml \
+	constitution-change-20040205.xml execmanual.xml procedure.xml
 
 include ../default.mk
diff --git a/docs/directory.xml b/docs/directory.xml
index 4fc0098..52e6b66 100644
--- a/docs/directory.xml
+++ b/docs/directory.xml
@@ -4,6 +4,5 @@
 
 <directory title="Documents">
   <diritem title="Official documents" href="official.html" />
-  <diritem title="Website documents" href="website.html" />
   <diritem title="Executive manual" href="execmanual.html" />
 </directory>
diff --git a/docs/editing-example1/Makefile b/docs/editing-example1/Makefile
deleted file mode 100644
index 95c1f96..0000000
--- a/docs/editing-example1/Makefile
+++ /dev/null
@@ -1,3 +0,0 @@
-INPUTS = operating-systems.xml
-
-include ../../default.mk
diff --git a/docs/editing-example1/directory.xml b/docs/editing-example1/directory.xml
deleted file mode 100644
index 14b9b7c..0000000
--- a/docs/editing-example1/directory.xml
+++ /dev/null
@@ -1,8 +0,0 @@
-<?xml version='1.0'?>
-
-<!DOCTYPE directory SYSTEM "../../csc.dtd">
-
-<directory title="Office">
-  <diritem title="Staff" href="staff.html" />
-  <diritem title="Books" href="books.html" />
-</directory>
diff --git a/docs/editing-example1/operating-systems.xml b/docs/editing-example1/operating-systems.xml
deleted file mode 100644
index aaea6d9..0000000
--- a/docs/editing-example1/operating-systems.xml
+++ /dev/null
@@ -1,6 +0,0 @@
-<?xml version='1.0'?>
-<!DOCTYPE cscpage SYSTEM "../../csc.dtd">
-<cscpage title="Operating Systems the CSC distributes" pre="../../">
- <header/>
- <footer/>
-</cscpage>
diff --git a/docs/editing-example2/Makefile b/docs/editing-example2/Makefile
deleted file mode 100644
index 95c1f96..0000000
--- a/docs/editing-example2/Makefile
+++ /dev/null
@@ -1,3 +0,0 @@
-INPUTS = operating-systems.xml
-
-include ../../default.mk
diff --git a/docs/editing-example2/directory.xml b/docs/editing-example2/directory.xml
deleted file mode 100644
index 1d3fe8e..0000000
--- a/docs/editing-example2/directory.xml
+++ /dev/null
@@ -1,9 +0,0 @@
-<?xml version='1.0'?>
-
-<!DOCTYPE directory SYSTEM "../../csc.dtd">
-
-<directory title="Office">
-  <diritem title="Staff" href="staff.html" />
-  <diritem title="Books" href="books.html" />
-  <diritem title="Operating Systems" href="operating-systems.html" />
-</directory>
diff --git a/docs/editing-example2/operating-systems.xml b/docs/editing-example2/operating-systems.xml
deleted file mode 100644
index aaea6d9..0000000
--- a/docs/editing-example2/operating-systems.xml
+++ /dev/null
@@ -1,6 +0,0 @@
-<?xml version='1.0'?>
-<!DOCTYPE cscpage SYSTEM "../../csc.dtd">
-<cscpage title="Operating Systems the CSC distributes" pre="../../">
- <header/>
- <footer/>
-</cscpage>
diff --git a/docs/editing-example3/Makefile b/docs/editing-example3/Makefile
deleted file mode 100644
index 95c1f96..0000000
--- a/docs/editing-example3/Makefile
+++ /dev/null
@@ -1,3 +0,0 @@
-INPUTS = operating-systems.xml
-
-include ../../default.mk
diff --git a/docs/editing-example3/directory.xml b/docs/editing-example3/directory.xml
deleted file mode 100644
index 1d3fe8e..0000000
--- a/docs/editing-example3/directory.xml
+++ /dev/null
@@ -1,9 +0,0 @@
-<?xml version='1.0'?>
-
-<!DOCTYPE directory SYSTEM "../../csc.dtd">
-
-<directory title="Office">
-  <diritem title="Staff" href="staff.html" />
-  <diritem title="Books" href="books.html" />
-  <diritem title="Operating Systems" href="operating-systems.html" />
-</directory>
diff --git a/docs/editing-example3/operating-systems.xml b/docs/editing-example3/operating-systems.xml
deleted file mode 100644
index c4a75f4..0000000
--- a/docs/editing-example3/operating-systems.xml
+++ /dev/null
@@ -1,13 +0,0 @@
-<?xml version='1.0'?>
-<!DOCTYPE cscpage SYSTEM "../../csc.dtd">
-<cscpage title="Operating Systems the CSC distributes" pre="../../">
- <header/>
-  <section title="List of operating systems">
-  <ul>
-  <li><a href="http://www.debian.org/">Debian GNU/Linux</a></li>
-  <li><a href="http://www.freebsd.org/">FreeBSD</a></li>
-  </ul>
-  <p>More operating systems may be available.</p>
-  </section>
- <footer/>
-</cscpage>
diff --git a/docs/editing-howto.xml b/docs/editing-howto.xml
deleted file mode 100644
index 828d2ae..0000000
--- a/docs/editing-howto.xml
+++ /dev/null
@@ -1,190 +0,0 @@
-<?xml version='1.0'?>
-
-<!DOCTYPE cscpage SYSTEM "../csc.dtd">
-
-<cscpage title="CSC Website Editing Howto">
-  <header/>
-  <section title="Getting started">
-    <p>
-      In order to edit the website you will first have to get the CVS
-      repository in which it is stored. To do so, go somewhere in your
-      home directory and type:
-    </p>
-    <code>
-      export CVS_RSH=ssh<br />
-      cvs -d username@caffeine.uwaterloo.ca:/u/www/cvsroot co www
-    </code>
-    <p>
-      Where <code>username</code> is your CSC user name. You will be
-      prompted for your password (unless you use an SSH key). After a
-      while you should have a new directory, <code>www/</code>, with
-      the CSC pages in it.
-    </p>
-    <p>
-      You will also need <code>libxslt</code> and <code>libxml</code>
-      (including development headers) from Gnome. In debian,
-      <code>apt-get install libxml2-dev libxslt1-dev</code>.
-    </p>
-  </section>
-  <section title="Compiling the website">
-    <p>
-      The CSC website is <i>compiled</i>. This means that when you
-      edit a page, you don't edit the HTML source directly, but
-      instead edit a page describing the page's <i>content</i> (and
-      some formatting) and then run a command to generate the HTML
-      page from these content description pages.
-    </p>
-    <p>
-      To generate the CSC website, make sure you are in the directory
-      into which you checked it out (the <code>www/</code> directory)
-      and enter
-    </p>
-    <code>
-      make
-    </code>
-    <p>
-      This will compile the whole website. After any changes you make
-      you will have to recompile the website in the same manner.
-    </p>
-  </section>
-  <section title="Adding a regular page">
-    <p>
-      Let's now suppose we want to add a page detailing what operating
-      systems the CSC distributes through its CD-burning. First, we go
-      to the appropriate directory, in this case probably
-      <code>www/office</code>. Here we now open a new file called
-      <code>operating-systems.xml</code> in our favourite text editor
-      (emacs, of course). Take note that the filename ends in
-      <code>.xml</code>. All CSC web pages should have this file
-      ending.
-    </p>
-    <p>
-      The next thing to do is to add a few standard XML things to the
-      file. We add the two lines:
-    </p>
-    <code>
-      &lt;&#63;xml version='1.0'&#63;&gt;<br />
-      &lt;!DOCTYPE cscpage SYSTEM &quot;../csc.dtd&quot;&gt;
-    </code>
-    <p>
-      Note the reference to the file <code>../csc.dtd</code>. This
-      file is located in the <code>www/</code> directory, which is the
-      parent directory of <code>www/office/</code>, therefore we use
-      <code>../</code>. These two lines should appear at the top of
-      every CSC web page.
-    </p>
-    <p>
-      Next we start the actual page. To begin, we open a
-      <code>cscpage</code> tag with the title attribute set to the
-      title of our page. We also want to add a header with the CSC
-      logo, the current section directory and the title of the
-      page. Don't worry though, as you'll see this is really easy. Add
-      the following two lines to the end of the page:
-    </p>
-    <code>
-      &lt;cscpage title=&quot;Operating Systems the CSC
-      distributes&quot;&gt;<br />
-      &lt;header /&gt;
-    </code>
-    <p>
-      That's it! So we can see what our page looks like so far, we
-      also add the footer (with the menu, generation date, and
-      copyright information) and we close the <code>cscpage</code>
-      tag. Add the following lines to the end:
-    </p>
-    <code>
-      &lt;footer /&gt;<br />
-      &lt;/cscpage&gt;
-    </code>
-    <p>
-      Notice how in the case of <code>header</code> and
-      <code>footer</code> we have a <code>/</code> before the
-      <code>&gt;</code>? This is one of the major differences between
-      HTML and XML: tags that don't really have an end tag, such as
-      <code>&lt;br&gt;</code> have to be specified as being
-      <i>empty</i> in XML by adding a <code>/</code> before the
-      <code>&gt;</code>. This is particularily important to remember
-      when you add XHTML (XML's version of HTML) to the page.
-    </p>
-    <p>
-      Now we want to see what the resulting HTML page looks like. But
-      first we have to tell <code>make</code> about our new page. To
-      do so, open up the file <code>www/office/Makefile</code>, find
-      the line beginning with <code>INPUTS = </code> and simply add
-      <code>operating-systems.xml</code> to the end of that line. So
-      the line might look like <code>INPUTS = index.html staff.xml
-      books.xml operating-systems.xml</code>. Save
-      <code>Makefile</code> and close it. Now, in the
-      <code>www/</code> directory, type <code>make</code>. This will
-      build the whole website, (hopefully!) including our little
-      document. Once <code>make</code> is done, have a look at the
-      resulting file,
-      <code>www/office/operating-systems.html</code>. It should look
-      like <a href="editing-example1/operating-systems.html">example
-      1</a> (use your browsers Back button to return to this page
-      after viewing the example).
-    </p>
-    <p>
-      Looking at the generated page, you may have noticed that it does
-      not yet appear in the menu at the top of the page. Opening up
-      the special file <code>www/office/directory.xml</code> you will
-      see several entries, each corresponding to one of the menu
-      items. After the last line beginning with
-      <code>&lt;diritem</code>, add in the following line:
-    </p>
-    <code>
-      &lt;diritem title=&quot;"Operating Systems&quot;
-      href=&quot;operating-systems.html&quot; /&gt;
-    </code>
-    <p>
-      Now recompile the site with <code>make</code>. You should see
-      that the page now looks something like <a
-      href="editing-example2/operating-systems.html">example
-      2</a>. Also note that all the other office pages will now have a
-      reference to the new operating systems page.
-    </p>
-    <p>
-      With that out of the way, it's time to add some content. You may
-      be happy to hear that you can add regular (X)HTML to any CSC web
-      page. So, we'll add the following content between the
-      <code>&lt;header /&gt;</code> and <code>&lt;footer /&gt;</code>
-      of the page:
-    </p>
-    <code>
-      &lt;section title=&quot;List of operating systems&quot;&gt;<br/>
-      &lt;ul&gt;<br/>
-	&lt;li&gt;&lt;a href=&quot;http://www.debian.org/&quot;&gt;Debian GNU/Linux&lt;/a&gt;&lt;/li&gt;<br/>
-	&lt;li&gt;&lt;a href=&quot;http://www.freebsd.org/&quot;&gt;FreeBSD&lt;/a&gt;&lt;/li&gt;<br/>
-      &lt;/ul&gt;<br/>
-      &lt;p&gt;More operating systems may be available.&lt;/p&gt;<br/>
-      &lt;/section&gt;<br/>
-    </code>
-    <p>
-      As usual, compile your changes using <code>make</code> and have
-      a look. The resulting file should look something like <a
-      href="editing-example3/operating-systems.html">example 3</a>. A
-      few things to keep in mind are:
-    </p>
-    <ul>
-      <li>
-	Always use lower-case in your XHTML tags. XML is
-	case-sensitive. For example: <code>&lt;br/&gt;</code> is good
-	whereas <code>&lt;BR/&gt;</code> is bad.
-      </li>
-      <li>
-	Always close your tags. If it's a tag that never encloses
-	anything use the <code>&lt;tag/&gt;</code> syntax. For
-	example: <code>&lt;ul&gt; &lt;li&gt;Item
-	1&lt;br/&gt;Linebreak&lt;/li&gt; &lt;li&gt;Item
-	2&lt;/li&gt;&lt;/ul&gt;</code> is good, whereas
-	<code>&lt;ul&gt; &lt;li&gt;Item
-	1&lt;br&gt;Linebreak &lt;li&gt;Item 2&lt;/ul&gt;</code> is bad.
-      </li>
-      <li>
-	You must place HTML code inside <code>&lt;section&gt;</code>
-	tags. You can have as many section as you want on the page.
-      </li>
-    </ul>
-  </section>
-  <footer />
-</cscpage>
diff --git a/docs/index.xml b/docs/index.xml
index a1ef949..c35a465 100644
--- a/docs/index.xml
+++ b/docs/index.xml
@@ -11,7 +11,6 @@
   </p>
     <ul>
       <li><a href="official.html">Official documents</a></li>
-      <li><a href="website.html">Documentation about the website</a></li>
       <li><a href="execmanual.html">Manual for new executives</a></li>
       <li><a href="procedure.html">Old CSC Procedures manual</a>, to
       be integrated into the new exec manual</li>
diff --git a/docs/website.xml b/docs/website.xml
index 527a7ee..7aef92e 100644
--- a/docs/website.xml
+++ b/docs/website.xml
@@ -21,10 +21,6 @@
       generating the <a href="../events/">events pages</a>).
     </p>
   </section>
-  <section title="Adding to the website">
-    <p>See the <a href="editing-howto.html">Editing Howto</a> for
-    information on editing the website</p>
-  </section>
   <section title="Links">
     <p>
       I have provided some helpful links regarding XSLT and XML below.