/[volute]/trunk/projects/ivoapub/ivoatexDoc/ivoatexDoc.tex
ViewVC logotype

Diff of /trunk/projects/ivoapub/ivoatexDoc/ivoatexDoc.tex

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 3170 by msdemlei, Tue Nov 24 09:35:29 2015 UTC revision 3171 by msdemlei, Thu Dec 3 07:04:05 2015 UTC
# Line 36  Line 36 
36    
37  \editor{Markus Demleitner}  \editor{Markus Demleitner}
38    
39  \previousversion{This is the first public release}  \previousversion[http://www.ivoa.net/documents/ivoatexDoc/20150129][Version
40    1.0]
41                
42    
43  \begin{document}  \begin{document}
# Line 708  Line 709 
709    
710  and forget about the problem.  and forget about the problem.
711    
 The authors gladly will support efforts to add support for other version  
 control systems to \ivoatex.  
   
712    
713  \subsection{Generated Content}  \subsection{Generated Content}
714  \label{sect:generated}  \label{sect:generated}
# Line 746  Line 744 
744  if even just one command fails to execute as indicated by the  if even just one command fails to execute as indicated by the
745  command's return code; it is transactional in this sense.  command's return code; it is transactional in this sense.
746    
747    We mention in passing that in addition to allowing arbitrary shell
748    commands, \texttt{update\_generated.py} has a facility that allows
749    calling special python functions from within documents: Commands starting
750    with an exclamation mark (``!'') are interpreted as such calls to
751    functions defined within \texttt{update\_generated.py}.
752    Currently, the only such builtin command extracts documentation from a
753    live \texttt{TAP\_SCHEMA}\footnote{It is in use in the
754    \href{https://volute.g-vo.org/svn/trunk/projects/registry/discovercollections}{Discovering
755    Data Collections Within Services} IVOA Note.}.  For now, this should be
756    considered an unstable experiment, but authors wanting to try inline
757    python for content generation are welcome to do so.
758    
759  \ivoatex will never execute \texttt{update\_generated.py} as part of a  \ivoatex will never execute \texttt{update\_generated.py} as part of a
760  dependency chain; it is intended that \texttt{make generate} must always  dependency chain; it is intended that \texttt{make generate} must always
761  been manually triggered.  On the one hand, this is because its  been manually triggered.  On the one hand, this is because its
# Line 763  Line 773 
773  identical to the document author, and the makefile can already contain  identical to the document author, and the makefile can already contain
774  arbitrary commands that would be executed on the calling user's behalf.  arbitrary commands that would be executed on the calling user's behalf.
775    
776  \subsubsection{Schema documentation}  \subsubsection{XML Schema documentation}
777    
778  A common use case for this facility is building documentation from XML  A common use case for this facility is building documentation from XML
779  schema files.  To support it, \ivoatex\ comes with an XSLT file  schema files.  To support it, \ivoatex\ comes with an XSLT file
# Line 778  Line 788 
788  in the file, so the recommendation to keep source lines shorter than 72  in the file, so the recommendation to keep source lines shorter than 72
789  characters clearly does not apply here.  characters clearly does not apply here.
790    
791    
792  \section{Customisation and Development}  \section{Customisation and Development}
793  \label{sect:impl}  \label{sect:impl}
794    

Legend:
Removed from v.3170  
changed lines
  Added in v.3171

msdemlei@ari.uni-heidelberg.de
ViewVC Help
Powered by ViewVC 1.1.26