source: softGlue_examples/source/adding_examples.rst @ 878

Last change on this file since 878 was 878, checked in by jemian, 10 years ago

add some help

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Revision Author HeadURL Id
File size: 1.9 KB
Line 
1.. $Id: adding_examples.rst 878 2012-06-05 21:36:27Z jemian $
2
3===========================================
4Adding new examples
5===========================================
6
7To :index:`!add new examples`, follow these steps:
8
9#. make a new subdirectory under ``source/``
10#. copy any image files into this new subdirectory
11#. copy ``programmable_pulse_train/index.rst`` 
12   into this new subdirectory
13#. edit the new ``index.rst`` file to show the
14   images and text for this new example
15#. edit ``source/index.rst`` and add a reference to
16   the new directory in the ``toctree`` under
17   ``programmable_pulse_train/index``
18#. in ``source``, add the new directory to subversion
19#. in ``source/..`` (parent directory), type ``make html`` 
20   to rebuild the web site
21#. it may be necessary to tell subversion the mime
22   type of the html file(s), see below
23#. in the same directory, do a subversion checkin: 
24   ``svn ci -m "new example"``
25
26setting the subversion mime type of a file
27++++++++++++++++++++++++++++++++++++++++++
28
29=========  ===============================================
30extension  command
31=========  ===============================================
32``.html``  ``svn ps svn:mime-type text/html``
33``.css``   ``svn ps svn:mime-type text/css``
34``.js``    ``svn ps svn:mime-type text/javascript``
35=========  ===============================================
36
37Any of these commands may be useful at times when adding
38new examples so the HTML files display properly from the
39subversion repository server::
40
41        cd {softGlue_examples}
42        svn st -u
43        svn add {any content from previous command with "?" in left column}
44        svn ps svn:mime-type text/html build/html/*.html
45        svn ps svn:mime-type text/html build/html/*/*.html
46        svn ps svn:mime-type text/javascript build/html/_static/*.js
47        svn ps svn:mime-type text/css build/html/_static/*.css
48
49
50.. note:: Web documentation available from the SVN server:
51
52   https://subversion.xor.aps.anl.gov/bcdaext/softGlue_examples/build/html/index.html
Note: See TracBrowser for help on using the repository browser.