[NeXus-tech] NXdetector manual

[Pete Jemian]

Eugen:

This is great!  Absolutely, this would make a great Appendix in the 
manual.  I can work with you to help you get code examples into the 
work.  The h5py examples are a good template.  They are placed in their 
own subdirectory and have code examples and figures and data files.

Having used both LaTeX and rst, I can tell you that LaTeX offers greater 
control when you are writing a document with a specific output form 
(letter, book, thesis, journal article, howto).  When you are 
collaborating on documentation, such as this new effort, rst is the tool 
to be used.

What would be the point of a git repo for this?

Pete

On 11/25/2013 10:04 AM, Wintersberger, Eugen wrote:
> Hi folks
>   on the last telecon Herbert requested a manual of how to use NXdetector
> for more complex setups. I started now with writing such a manual.
> However I already ran into problems with rather simple things. Some of
> the fields in NXdetector are undocumented or their documentation is
> incomplete.
>
> I made a list of the fields I find confusing on the wiki
> http://wiki.nexusformat.org/NXdetector_documentation
>
> Some technical question concerning the manual: I started to do this in
> Latex as it is just simpler to use than Wikis or Sphinx (in particular
> if you have sequences of code that you want to refer to in the text) -
> at least in my opinion ;) Is this ok for you, or would you prefer a
> different format?
> It would be a good idea to have a GIT repository somewhere available for
> others to download. Shall I create one on github or do we have a
> suitable location somewhere else?
>
> regards
>    Eugen
>
>
>
> _______________________________________________
> NeXus-tech mailing list
> NeXus-tech at nexusformat.org
> http://lists.nexusformat.org/mailman/listinfo/nexus-tech
>