source: softGlue_examples/build/html/adding_examples.html @ 879

Last change on this file since 879 was 879, checked in by jemian, 13 years ago

straggler
  • Property svn:mime-type set to text/html
File size: 8.1 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6
7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
11    <title>Adding new examples &mdash; softglueexamples 2012-06 documentation</title>
12   
13    <link rel="stylesheet" href="_static/default.css" type="text/css" />
14    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
15   
16    <script type="text/javascript">
17      var DOCUMENTATION_OPTIONS = {
18        URL_ROOT:    '',
19        VERSION:     '2012-06',
20        COLLAPSE_INDEX: false,
21        FILE_SUFFIX: '.html',
22        HAS_SOURCE:  true
23      };
24    </script>
25    <script type="text/javascript" src="_static/jquery.js"></script>
26    <script type="text/javascript" src="_static/underscore.js"></script>
27    <script type="text/javascript" src="_static/doctools.js"></script>
28    <link rel="top" title="softglueexamples 2012-06 documentation" href="index.html" />
29    <link rel="next" title="Additional Coaching on the use of reStructuredText" href="coaching.html" />
30    <link rel="prev" title="Programmable pulse train" href="programmable_pulse_train/index.html" /> 
31  </head>
32  <body>
33    <div class="related">
34      <h3>Navigation</h3>
35      <ul>
36        <li class="right" style="margin-right: 10px">
37          <a href="genindex.html" title="General Index"
38             accesskey="I">index</a></li>
39        <li class="right" >
40          <a href="coaching.html" title="Additional Coaching on the use of reStructuredText"
41             accesskey="N">next</a> |</li>
42        <li class="right" >
43          <a href="programmable_pulse_train/index.html" title="Programmable pulse train"
44             accesskey="P">previous</a> |</li>
45        <li><a href="index.html">softglueexamples 2012-06 documentation</a> &raquo;</li> 
46      </ul>
47    </div> 
48
49    <div class="document">
50      <div class="documentwrapper">
51        <div class="bodywrapper">
52          <div class="body">
53           
54  <div class="section" id="adding-new-examples">
55<h1>Adding new examples<a class="headerlink" href="#adding-new-examples" title="Permalink to this headline">¶</a></h1>
56<p>To <span class="target" id="index-0"></span>add new examples, follow these steps:</p>
57<ol class="arabic simple">
58<li>make a new subdirectory under <tt class="docutils literal"><span class="pre">source/</span></tt></li>
59<li>copy any image files into this new subdirectory</li>
60<li>copy <tt class="docutils literal"><span class="pre">programmable_pulse_train/index.rst</span></tt>
61into this new subdirectory</li>
62<li>edit the new <tt class="docutils literal"><span class="pre">index.rst</span></tt> file to show the
63images and text for this new example</li>
64<li>edit <tt class="docutils literal"><span class="pre">source/index.rst</span></tt> and add a reference to
65the new directory in the <tt class="docutils literal"><span class="pre">toctree</span></tt> under
66<tt class="docutils literal"><span class="pre">programmable_pulse_train/index</span></tt></li>
67<li>in <tt class="docutils literal"><span class="pre">source</span></tt>, add the new directory to subversion</li>
68<li>in <tt class="docutils literal"><span class="pre">source/..</span></tt> (parent directory), type <tt class="docutils literal"><span class="pre">make</span> <span class="pre">html</span></tt>
69to rebuild the web site</li>
70<li>it may be necessary to tell subversion the mime
71type of the html file(s), see below</li>
72<li>in the same directory, do a subversion checkin:
73<tt class="docutils literal"><span class="pre">svn</span> <span class="pre">ci</span> <span class="pre">-m</span> <span class="pre">&quot;new</span> <span class="pre">example&quot;</span></tt></li>
74</ol>
75<div class="section" id="setting-the-subversion-mime-type-of-a-file">
76<h2>setting the subversion mime type of a file<a class="headerlink" href="#setting-the-subversion-mime-type-of-a-file" title="Permalink to this headline">¶</a></h2>
77<table border="1" class="docutils">
78<colgroup>
79<col width="16%" />
80<col width="84%" />
81</colgroup>
82<thead valign="bottom">
83<tr class="row-odd"><th class="head">extension</th>
84<th class="head">command</th>
85</tr>
86</thead>
87<tbody valign="top">
88<tr class="row-even"><td><tt class="docutils literal"><span class="pre">.html</span></tt></td>
89<td><tt class="docutils literal"><span class="pre">svn</span> <span class="pre">ps</span> <span class="pre">svn:mime-type</span> <span class="pre">text/html</span></tt></td>
90</tr>
91<tr class="row-odd"><td><tt class="docutils literal"><span class="pre">.css</span></tt></td>
92<td><tt class="docutils literal"><span class="pre">svn</span> <span class="pre">ps</span> <span class="pre">svn:mime-type</span> <span class="pre">text/css</span></tt></td>
93</tr>
94<tr class="row-even"><td><tt class="docutils literal"><span class="pre">.js</span></tt></td>
95<td><tt class="docutils literal"><span class="pre">svn</span> <span class="pre">ps</span> <span class="pre">svn:mime-type</span> <span class="pre">text/javascript</span></tt></td>
96</tr>
97</tbody>
98</table>
99<p>Any of these commands may be useful at times when adding
100new examples so the HTML files display properly from the
101subversion repository server:</p>
102<div class="highlight-python"><pre>cd {softGlue_examples}
103svn st -u
104svn add {any content from previous command with "?" in left column}
105svn ps svn:mime-type text/html build/html/*.html
106svn ps svn:mime-type text/html build/html/*/*.html
107svn ps svn:mime-type text/javascript build/html/_static/*.js
108svn ps svn:mime-type text/css build/html/_static/*.css</pre>
109</div>
110<div class="admonition note">
111<p class="first admonition-title">Note</p>
112<p>Web documentation available from the SVN server:</p>
113<p class="last"><a class="reference external" href="https://subversion.xor.aps.anl.gov/bcdaext/softGlue_examples/build/html/index.html">https://subversion.xor.aps.anl.gov/bcdaext/softGlue_examples/build/html/index.html</a></p>
114</div>
115</div>
116</div>
117
118
119          </div>
120        </div>
121      </div>
122      <div class="sphinxsidebar">
123        <div class="sphinxsidebarwrapper">
124  <h3><a href="index.html">Table Of Contents</a></h3>
125  <ul>
126<li><a class="reference internal" href="#">Adding new examples</a><ul>
127<li><a class="reference internal" href="#setting-the-subversion-mime-type-of-a-file">setting the subversion mime type of a file</a></li>
128</ul>
129</li>
130</ul>
131
132  <h4>Previous topic</h4>
133  <p class="topless"><a href="programmable_pulse_train/index.html"
134                        title="previous chapter">Programmable pulse train</a></p>
135  <h4>Next topic</h4>
136  <p class="topless"><a href="coaching.html"
137                        title="next chapter">Additional Coaching on the use of reStructuredText</a></p>
138  <h3>This Page</h3>
139  <ul class="this-page-menu">
140    <li><a href="_sources/adding_examples.txt"
141           rel="nofollow">Show Source</a></li>
142  </ul>
143<div id="searchbox" style="display: none">
144  <h3>Quick search</h3>
145    <form class="search" action="search.html" method="get">
146      <input type="text" name="q" />
147      <input type="submit" value="Go" />
148      <input type="hidden" name="check_keywords" value="yes" />
149      <input type="hidden" name="area" value="default" />
150    </form>
151    <p class="searchtip" style="font-size: 90%">
152    Enter search terms or a module, class or function name.
153    </p>
154</div>
155<script type="text/javascript">$('#searchbox').show(0);</script>
156        </div>
157      </div>
158      <div class="clearer"></div>
159    </div>
160    <div class="related">
161      <h3>Navigation</h3>
162      <ul>
163        <li class="right" style="margin-right: 10px">
164          <a href="genindex.html" title="General Index"
165             >index</a></li>
166        <li class="right" >
167          <a href="coaching.html" title="Additional Coaching on the use of reStructuredText"
168             >next</a> |</li>
169        <li class="right" >
170          <a href="programmable_pulse_train/index.html" title="Programmable pulse train"
171             >previous</a> |</li>
172        <li><a href="index.html">softglueexamples 2012-06 documentation</a> &raquo;</li> 
173      </ul>
174    </div>
175    <div class="footer">
176        &copy; Copyright 2012, Kurt Goetze, BCDA.
177      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
178    </div>
179  </body>
180</html>
Note: See TracBrowser for help on using the repository browser.