Initial import of style repo.

[sitka/doc/style.git] / style / style-template.xml

<?xml version="1.0" encoding="utf-8"?>\r
<chapter xml:id="style-template" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="EN"\r
    xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink">\r
\r
    <info>\r
        <revhistory>\r
            <revision>\r
                <revnumber>1</revnumber>\r
                <date>2009-10-13</date>\r
                <authorinitials>JB</authorinitials>\r
                <revremark>Revised to include example of revhistory element</revremark>\r
            </revision>\r
        </revhistory>\r
\r
        <title>Sitka Documentation Template</title>\r
    </info>\r
\r
    <para>The source xml file for this template page is in the Sitka DocBook directory at\r
            <emphasis>www/Sitka/draft/template.xml</emphasis>. To use it as a template for new Sitka\r
        documenation follow the steps below.</para>\r
\r
    <section>\r
        <info>\r
            <title>Open <emphasis>template.xml</emphasis></title>\r
        </info>\r
\r
        <para>Optional intro paragraph for section</para>\r
\r
        <procedure>\r
            <step>\r
                <para>Open oXygen XML Author or Editor</para>\r
            </step>\r
\r
            <step>\r
                <para>Right-click <guilabel>newProject.xpr</guilabel> (in the left column) and\r
                    choose <guimenuitem>Import Remote Folders</guimenuitem></para>\r
            </step>\r
\r
            <step>\r
                <para>Enter DocBook server url, username, and password for SFTP connection (not\r
                    publicly available), then click <guibutton>Browse</guibutton></para>\r
            </step>\r
\r
            <step>\r
                <informalfigure>\r
                    <para>Navigate to /home/jbuhler/www/Sitka/draft. Select this folder, then click\r
                            <guibutton>OK</guibutton> (ed note: this is also an example of how to\r
                        keep step text and image together, displaying an image that's less than\r
                        900px wide)</para>\r
                    <para>\r
                        <mediaobject>\r
                            <alt>screenshot of staff client</alt>\r
                            <imageobject>\r
                                <imagedata scalefit="0" fileref="media/style-template-1.png"/>\r
                            </imageobject>\r
                        </mediaobject>\r
                    </para>\r
                </informalfigure>\r
            </step>\r
\r
            <step>\r
                <para>In oXygen, double-click on <guilabel>newProject.xpr*</guilabel>. Navigate to\r
                        <emphasis>draft/template.xml</emphasis>, then double-click it to open</para>\r
            </step>\r
\r
            <step>\r
                <informalfigure>\r
                    <para><emphasis>template.xml</emphasis> will open in oXygen (ed note: this is\r
                        also an example of how to keep step text and image together, displaying an\r
                        image that's wider than 900px)</para>\r
                    <para>\r
                        <mediaobject>\r
                            <alt>screenshot of staff client</alt>\r
                            <imageobject>\r
                                <imagedata width="100%" scalefit="1"\r
                                    fileref="media/style-template-2.png"/>\r
                            </imageobject>\r
                        </mediaobject>\r
                    </para>\r
                </informalfigure>\r
            </step>\r
        </procedure>\r
\r
    </section>\r
\r
    <section>\r
        <info>\r
            <title>Save as new xml file</title>\r
        </info>\r
\r
        <para>Optional intro paragraph for section</para>\r
\r
        <procedure>\r
            <step>\r
                <para>Make the following changes to <emphasis>template.xml</emphasis></para>\r
                <itemizedlist>\r
                    <listitem>\r
                        <para>Change the chapter xml:id from <emphasis>style-template</emphasis> to\r
                            a new unique value</para>\r
                    </listitem>\r
                    <listitem>\r
                        <para>Change the title from <emphasis>Sitka Documentation\r
                                Template</emphasis></para>\r
                    </listitem>\r
                </itemizedlist>\r
            </step>\r
\r
            <step>\r
                <para>Go to <menuchoice>\r
                        <guimenu>File</guimenu>\r
                        <guimenuitem>Save to URL...</guimenuitem>\r
                    </menuchoice> and save to desired Sitka docs directory (using a newly assigned\r
                    name, not <emphasis>template.xml</emphasis>)</para>\r
            </step>\r
\r
            <step>\r
                <para>While customizing the file, use <keycombo>\r
                        <keycap>Ctrl</keycap>\r
                        <keycap>S</keycap>\r
                    </keycombo> to save changes</para>\r
            </step>\r
\r
            <step>\r
                <para>Open <emphasis>root.xml</emphasis> and add a new\r
                        <emphasis>xi:includes</emphasis> line pointing to the newly created file,\r
                    adding it to the larger Sitka doc set; save changes</para>\r
            </step>\r
        </procedure>\r
\r
        <para/>\r
        <tip>\r
            <para>Use <keycombo>\r
                    <keycap>Ctrl</keycap>\r
                    <keycap>Shift</keycap>\r
                    <keycap>P</keycap>\r
                </keycombo> to automatically indent and space an xml file in oXygen, making it\r
                easier to read and work with</para>\r
        </tip>\r
\r
    </section>\r
\r
</chapter>\r