[NeXus-tech] NXdetector manual

[Wintersberger, Eugen]

Hi Pete 
On Mon, 2013-11-25 at 10:19 -0600, Pete Jemian wrote:
> 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.

It will take some while until I have some code. What is more puzzling at
the moment is how to get all the parameters of detectors right at
beamlines where the detector setup changes quickly. 
I was thingking about some tools which should help to determine them
when changing to a new detector - but nothing concrete for the moment. 

> 
> 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.

There are several problems that I have with rst (but may you can help
me)
.) how to place images properly and reference them in the text
.) how difficult is it to use mathematical expressions (is mathjax used
for HTML output?)
.) how to get code snippets into the text that can be referenced
throughout the text and have nice syntax highlighting (I currently use
the minted package in Latex which uses pygmented for generating the
highlighted code). 

What I read about RST and the code I have seen it looks more like plain
tex ;) when one wants to have some more elaborate features. But if you
have some links to good documentation (the sphinx documentation did not
bring to much enlightenment ;)) please let me know. 

> 
> 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
> >
> _______________________________________________
> NeXus-tech mailing list
> NeXus-tech at nexusformat.org
> http://lists.nexusformat.org/mailman/listinfo/nexus-tech

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 230 bytes
Desc: This is a digitally signed message part
URL: <http://lists.nexusformat.org/mailman/private/nexus-tech/attachments/20131125/8df74a11/attachment.sig>