Sébastien Masson Sebastien.Masson_at_locean-ipsl.upmc.fr Françoise Pinsard Francoise.Pinsard_at_locean-ipsl.upmc.fr IDL SAXO FAQ 0.0 August 2006 First draft 0.1 September 2006 + onlinehelp 0.2 April 2008 migration from DocBook 4.2 to Docbook 5.0 $Id$ This is a list of Frequently Asked Questions about SAXO. This list is roughly divided into categories: general questions, technical questions, contributors questions. Suggestions for corrections or additional sections are welcome -- please email them to saxo-dev@forge.ipsl.jussieu.fr. What is SAXO ? see document What is SAXO. How can I get help ? see Support in document Main page of SAXO. How do I get SAXO ? see document Get SAXO. What is the current version of SAXO ? On what systems does SAXO run ? Does SAXO works with GDL instead of IDL ? Not yet. When is the next version of SAXO due out ? How can I find if a routine to do what I want already exists ? How should SAXO be cited or acknowledged in publication ? Is there on-line help for SAXO ? Yes, if you use at least IDL 6.2. It is produced by IDLdoc. SAXO and IDL online_help have been merged, you can simply get the help by typing: &promptidl; ? Is there an SAXO Style Guide available ? There is a template for header new_header.txt which can be parsed by IDLdoc. This file can be added in Emacs configuration C-cC-h IDLWAVE Templates Doc Header . in your ${HOME}/.emacs like this : (add-hook 'idlwave-mode-hook (function (lambda () (setq idlwave-file-header '("SAXO_basedirectory/SAXO_DIR/SRC/Documentation/new_header.txt") )))) Is there any trouble with IDLdoc ? Yes, there are some : \ in *.pro are not written in *.html. They must be escaped by an other \ or you can choose an other character. The search facility (Search) doesn't handle characters like - and |. Paragraphs of *.pro headers are shown with a proportional font in the HTML release. If you need to draw some small figure like grid cell, you can encapsulate the block to be shown in constant font between ; <fixe> and ; </fixe> Unfortunately, these troubles may not be fixed because the author does not have anymore the opportunity to work on his own work. Bugs can be submitted to IDL but we do not expect answers ! How can I check spelling of XML files ? There is one way with command line : $ aspell --mode=sgml -c xmlfile How can I check spelling of IDL files ? Not so easy but you can start with something like this : $ cd ${HOME}/SAXO_DIR/SRC/ $ list=$(find . -name "*.pro") $ for file in ${list}; do aspell list < ${file}; done > /tmp/list_word $ sort -u /tmp/list_word > /tmp/list_sort This will give /tmp/list_sort a list of sorted word used in IDL files that are not in the default dictionnary. Some of these words are correct in IDL and SAXO vocabulary, so they do not have to be replaced but some typo can be found. To find occurences of one of these misspelled words, you have to do this : $ find . -name "*.pro" -exec grep -h "misspelled_word" {} \; We should improve this by providing some IDL and SAXO dictionnary. How can I see online help update ? You won't see online help update if you are working with the official distribution because of !HELP_PATH. To override this problem, when you are in SAXO_basedirectory/SAXO_DIR/SRC/Documentation/xmldoc/, you can call online help like this : &promptidl; ONLINE_HELP,book="../idldoc_assistant_output/idldoc-lib.adp"