add new setting for received status
[sitka/doc/acquisitions.git] / template.xml
1 <?xml version="1.0" encoding="utf-8"?>\r
2 <chapter xml:id="style-template" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="EN"\r
3     xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink">\r
4     \r
5     <info>\r
6         <revhistory>\r
7             <revision>\r
8                 <date>2009-10-13</date>\r
9                 <authorinitials>JB</authorinitials>\r
10                 <revremark>Revised to include example of revhistory element</revremark>\r
11             </revision>\r
12         </revhistory>\r
13         \r
14         <title>Sitka Documentation Template</title>\r
15     </info>\r
16     \r
17     <para>The source xml file for this template page is in the Sitka DocBook directory at\r
18         <emphasis>www/Sitka/draft/template.xml</emphasis>. To use it as a template for new Sitka\r
19         documenation follow the steps below.</para>\r
20     \r
21     <section>\r
22         <info>\r
23             <title>Open <emphasis>template.xml</emphasis></title>\r
24         </info>\r
25         \r
26         <para>Optional intro paragraph for section</para>\r
27         \r
28         <procedure>\r
29             <step>\r
30                 <para>Open oXygen XML Author or Editor</para>\r
31             </step>\r
32             \r
33             <step>\r
34                 <para>Right-click <guilabel>newProject.xpr</guilabel> (in the left column) and\r
35                     choose <guimenuitem>Import Remote Folders</guimenuitem></para>\r
36             </step>\r
37             \r
38             <step>\r
39                 <para>Enter DocBook server url, username, and password for SFTP connection (not\r
40                     publicly available), then click <guibutton>Browse</guibutton></para>\r
41             </step>\r
42             \r
43             <step>\r
44                 <informalfigure>\r
45                     <para>Navigate to /home/jbuhler/www/Sitka/draft. Select this folder, then click\r
46                         <guibutton>OK</guibutton> (ed note: this is also an example of how to\r
47                         keep step text and image together, displaying an image that's less than\r
48                         900px wide)</para>\r
49                     <para>\r
50                         <mediaobject>\r
51                             <alt>screenshot of staff client</alt>\r
52                             <imageobject>\r
53                                 <imagedata scalefit="0" fileref="media/style-template-1.png"/>\r
54                             </imageobject>\r
55                         </mediaobject>\r
56                     </para>\r
57                 </informalfigure>\r
58             </step>\r
59             \r
60             <step>\r
61                 <para>In oXygen, double-click on <guilabel>newProject.xpr*</guilabel>. Navigate to\r
62                     <emphasis>draft/template.xml</emphasis>, then double-click it to open</para>\r
63             </step>\r
64             \r
65             <step>\r
66                 <informalfigure>\r
67                     <para><emphasis>template.xml</emphasis> will open in oXygen (ed note: this is\r
68                         also an example of how to keep step text and image together, displaying an\r
69                         image that's wider than 920px)</para>\r
70                     <para>\r
71                         <mediaobject>\r
72                             <alt>screenshot of staff client</alt>\r
73                             <imageobject>\r
74                                 <imagedata width="100%" scalefit="1" fileref="media/style-template-2.png"/>\r
75                             </imageobject>\r
76                         </mediaobject>\r
77                     </para>\r
78                 </informalfigure>\r
79             </step>\r
80         </procedure>\r
81         \r
82     </section>\r
83     \r
84     <section>\r
85         <info>\r
86             <title>Save as new xml file</title>\r
87         </info>\r
88         \r
89         <para>Optional intro paragraph for section</para>\r
90         \r
91         <procedure>\r
92             <step>\r
93                 <para>Make the following changes to <emphasis>template.xml</emphasis></para>\r
94                 <itemizedlist>\r
95                     <listitem>\r
96                         <para>Change the chapter xml:id from <emphasis>style-template</emphasis> to\r
97                             a new unique value</para>\r
98                     </listitem>\r
99                     <listitem>\r
100                         <para>Change the title from <emphasis>Sitka Documentation\r
101                             Template</emphasis></para>\r
102                     </listitem>\r
103                 </itemizedlist>\r
104             </step>\r
105             \r
106             <step>\r
107                 <para>Go to <menuchoice>\r
108                     <guimenu>File</guimenu>\r
109                     <guimenuitem>Save to URL...</guimenuitem>\r
110                 </menuchoice> and save to desired Sitka docs directory (using a newly assigned\r
111                     name, not <emphasis>template.xml</emphasis>)</para>\r
112             </step>\r
113             \r
114             <step>\r
115                 <para>While customizing the file, use <keycombo>\r
116                     <keycap>Ctrl</keycap>\r
117                     <keycap>S</keycap>\r
118                 </keycombo> to save changes</para>\r
119             </step>\r
120             \r
121             <step>\r
122                 <para>Open <emphasis>root.xml</emphasis> and add a new\r
123                     <emphasis>xi:includes</emphasis> line pointing to the newly created file,\r
124                     adding it to the larger Sitka doc set; save changes</para>\r
125             </step>\r
126         </procedure>\r
127         \r
128         <para/>\r
129         <tip>\r
130             <para>Use <keycombo>\r
131                 <keycap>Ctrl</keycap>\r
132                 <keycap>Shift</keycap>\r
133                 <keycap>P</keycap>\r
134             </keycombo> to automatically indent and space an xml file in oXygen, making it\r
135                 easier to read and work with</para>\r
136         </tip>\r
137         \r
138     </section>\r
139     \r
140 </chapter>\r