r1175: Working on stuff for the manual
authorRobert Sesek <rsesek@bluestatic.org>
Sun, 24 Sep 2006 21:53:35 +0000 (21:53 +0000)
committerRobert Sesek <rsesek@bluestatic.org>
Sun, 24 Sep 2006 21:53:35 +0000 (21:53 +0000)
locale/en_US/manual-xml/install.xml [new file with mode: 0644]
locale/en_US/manual-xml/manual.xml
locale/manual.xsl

diff --git a/locale/en_US/manual-xml/install.xml b/locale/en_US/manual-xml/install.xml
new file mode 100644 (file)
index 0000000..e05977b
--- /dev/null
@@ -0,0 +1,57 @@
+<chapter id="install" revision="$Revision$">
+       <title>Installation</title>
+       
+       <!-- =================================================================== -->
+       
+       <section id="install.config">
+               <title>The Configruation File</title>
+               <para>First, you have to rename the file <filename>includes/config.php.new</filename> to be <filename>includes/config.php</filename>.
+
+When you have done this, open it in a text editor.
+
+<note>Microsoft Windows users: do not use Notepad to do this. It may corrupt the file and make it unusable by your web server.</note>
+
+When you open it, you will find a list of variables. All but the following are required:
+
+<itemizedlist>
+       <listitem><varname>$usepconnect</varname></listitem>
+       <listitem><varname>$cookieprefix</varname></listitem>
+       <listitem><varname>$tableprefix</varname></listitem>
+</itemizedlist>
+
+All of the other fields have to be provided by your host--if you do not know them.
+
+Be sure in <varname>$pathtoisso</varname> that you place the full path to ISSO. That means that you shouldn't use a relative path like:
+
+<filename>../../isso/</filename>
+
+But instead, you should use:
+
+<filename>/home/user/htdocs/isso/</filename>
+
+Also make sure that it ends in a trailing slash!</para>
+       </section>
+       
+       <!-- =================================================================== -->
+       
+       <section id="install.run">
+               <title>Running the Installer</title>
+               <para>After modifying the configuration file, upload all of the files in the <filename>upload</filename> directory of your download package to the web server where you want.
+
+Be sure that these uploaded files include your modified <filename>includes/config.php</filename>.
+
+Once you have done this, go to your web browser and enter the address of your installation, plus <filename>/install/install.php</filename>. For instance, if I uploaded the installation to <filename>/bugtrack/</filename> on my server, I'd go to:
+
+<uri>http://www.example.com/bugtrack/install/install.php</uri>
+
+Once here, follow through the steps until your installation is complete.
+
+After you have completed installation and can log into the administrative control panel, be sure to delete this file on your web server:
+
+<filename>install/global.php</filename>
+
+If you do not do this, then people may be able to cause harm to your bug tracker.
+               </para>
+       </section>
+       
+</chapter>
\ No newline at end of file
index 71bba67b264f6fd912c9ceed84e04a2e312deb09..d7388c136ace0eb57316eb5e7a57bf5510d6614e 100644 (file)
@@ -1,25 +1,28 @@
 <?xml version="1.0" encoding="utf-8" ?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
-       "/usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd"
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V5.0//EN"
+       "http://www.oasis-open.org/docbook/xml/5.0b5/dtd/docbook.dtd"
 [
        <!ENTITY version "<productnumber>1.1.0</productnumber>">
        <!ENTITY product "<productname>Bugdar</productname>">
        <!ENTITY fullprod "<productname>&product; &version;</productname>">
+       
+       <!ENTITY chap01 SYSTEM "install.xml">
 ]>
 
-<book id="manual" lang="en">
+<book xmlns="http://docbook.org/ns/docbook">
 
-       <bookinfo>
+       <info>
                <title>&fullprod; Manual</title>
         <subtitle>&product;</subtitle>
         <pubdate><?dbtimestamp format="Y-m-d"?></pubdate>
         <copyright>
-            <year>2005-<?dbtimestamp format="Y"?></year>
-            <holder>
-                               Blue Static
-                               (<ulink url="http://www.bluestatic.org" />)
-            </holder>
+            <year>2005</year>
+            <year>2006</year>
+            <holder>Blue Static (<ulink url="http://www.bluestatic.org" />)</holder>
         </copyright>
-       </bookinfo>
+        <releaseinfo>Revision: $Revision$ ($Id$)</releaseinfo>
+       </info>
+       
+       &chap01;
 
 </book>
\ No newline at end of file
index 418857b4979482c6a0d56fe326d3258516b71227..13e069499ba579dbd304ee634030fb357a698657 100644 (file)
@@ -3,7 +3,7 @@
                 xmlns:fo="http://www.w3.org/1999/XSL/Format"   
                                version="1.0">
 
-<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl"/>
+<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/chunk.xsl"/>
        <xsl:param name="use.extensions">0</xsl:param>
        <xsl:param name="use.id.as.filename">1</xsl:param>
        <xsl:param name="base.dir">./</xsl:param>
        <xsl:param name="chunk.tocs.and.lots">0</xsl:param>
        <xsl:param name="html.extra.head.links">1</xsl:param>
        <xsl:param name="generate.manifest">1</xsl:param>
-       <xsl:param name="admon.graphics">1</xsl:param>
+       <xsl:param name="admon.graphics">0</xsl:param>
        <xsl:param name="admon.style"></xsl:param>
+       <xsl:param name="navig.graphics">0</xsl:param>
+       <xsl:param name="navig.showtitles">1</xsl:param>
        <xsl:param name="html.stylesheet">../../manual.css</xsl:param>
        <xsl:param name="header.rule">0</xsl:param>
        <xsl:param name="footer.rule">0</xsl:param>
-
-<xsl:template name="user.header.navigation">
-  <!-- stuff put here appears before the top navigation area -->
-</xsl:template>
-
-<xsl:template name="user.footer.navigation">
-  <!-- stuff put here appears after the bottom navigation area -->
-  <xsl:element name="div">
-    <xsl:attribute name="class">revinfo</xsl:attribute>
-    <xsl:value-of select="//pubdate[1]"/>
-  </xsl:element>
-</xsl:template>
-
-
-</xsl:stylesheet>
-<!--
-vim:se ts=2 sw=2 et:
--->
+</xsl:stylesheet>
\ No newline at end of file