diff options
author | Thomas White <taw@physics.org> | 2013-03-07 10:36:26 +0100 |
---|---|---|
committer | Thomas White <taw@physics.org> | 2013-03-07 10:36:26 +0100 |
commit | 33260b9a7bf27a87afa1dde789f0b0d9ce28eaab (patch) | |
tree | 686fcdfa791e2f4a14eb2f5575971021cde0d86f /doc/reference/libcrystfel/CrystFEL-docs.sgml | |
parent | 22cd1d08e6eeb6c8e43a709021746c057f6661d7 (diff) | |
parent | 1e03ed982741fdc576ec5a915da120450df20499 (diff) |
Merge branch 'tom/multicrystal'
Conflicts:
libcrystfel/src/mosflm.c
Diffstat (limited to 'doc/reference/libcrystfel/CrystFEL-docs.sgml')
-rw-r--r-- | doc/reference/libcrystfel/CrystFEL-docs.sgml | 126 |
1 files changed, 126 insertions, 0 deletions
diff --git a/doc/reference/libcrystfel/CrystFEL-docs.sgml b/doc/reference/libcrystfel/CrystFEL-docs.sgml new file mode 100644 index 00000000..1c91e72f --- /dev/null +++ b/doc/reference/libcrystfel/CrystFEL-docs.sgml @@ -0,0 +1,126 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> +]> +<book id="index"> + <bookinfo> + <title>CrystFEL Reference Manual</title> + <releaseinfo> + For libcrystfel from CrystFEL 0.4.3. + </releaseinfo> + <abstract> + This is the internal documentation for CrystFEL. Unless you are looking at + the code, writing new programs or fixing bugs, you should not need to read + this. You might use the information here when reading the code or to better + understand how the software works, or refer to it when creating a new + program within the suite. + </abstract> + </bookinfo> + + <chapter> + <title>Images</title> + <xi:include href="xml/image.xml"/> + </chapter> + + <chapter> + <title>Handling reflection data</title> + <abstract>There are three main reflection list thingies.</abstract> + <xi:include href="xml/reflist.xml"/> + <xi:include href="xml/reflist-utils.xml"/> + </chapter> + + <chapter> + <title>Unit cells</title> + <xi:include href="xml/unitcell.xml"/> + <xi:include href="xml/cell-utils.xml"/> + </chapter> + + <chapter> + <title>Crystals</title> + <xi:include href="xml/crystal.xml"/> + </chapter> + + <chapter> + <title>Geometry of diffraction</title> + <xi:include href="xml/geometry.xml"/> + </chapter> + + <chapter> + <title>Beam parameters</title> + <xi:include href="xml/beam-params.xml"/> + </chapter> + + <chapter> + <title>Peaks</title> + <xi:include href="xml/peaks.xml"/> + </chapter> + + <chapter> + <title>Image filters</title> + <xi:include href="xml/filter.xml"/> + </chapter> + + <chapter> + <title>Statistics and R-factors</title> + <xi:include href="xml/statistics.xml"><xi:fallback /></xi:include> + </chapter> + + <chapter> + <title>Symmetry</title> + <xi:include href="xml/symmetry.xml"><xi:fallback /></xi:include> + </chapter> + + <chapter> + <title>Integer Matrices</title> + <xi:include href="xml/integer_matrix.xml"><xi:fallback /></xi:include> + </chapter> + + <chapter> + <title>Indexing</title> + <xi:include href="xml/indexing.xml"><xi:fallback /></xi:include> + </chapter> + + <chapter> + <title>Detector</title> + <xi:include href="xml/detector.xml"><xi:fallback /></xi:include> + </chapter> + + <chapter> + <title>HDF5</title> + <xi:include href="xml/hdf5-file.xml"><xi:fallback /></xi:include> + </chapter> + + <chapter> + <title>Stream</title> + <xi:include href="xml/stream.xml"><xi:fallback /></xi:include> + </chapter> + + <chapter> + <title>Render</title> + <xi:include href="xml/render.xml"><xi:fallback /></xi:include> + </chapter> + + <chapter> + <title>Parallel programming</title> + <xi:include href="xml/thread-pool.xml"><xi:fallback /></xi:include> + </chapter> + + <chapter> + <title>Miscellaneous</title> + <xi:include href="xml/quaternion.xml"/> + <xi:include href="xml/utils.xml"/> + </chapter> + + <chapter> + <title>Information for developers</title> + <xi:include href="xml/coding-standards.xml"><xi:fallback /></xi:include> + </chapter> + + <index id="api-index-full"> + <title>API Index</title> + <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include> + </index> + +</book> |