From 0345245e860375a32c9a437c4a9d9cae807134e9 Mon Sep 17 00:00:00 2001 From: Shashank Date: Mon, 29 May 2017 12:40:26 +0530 Subject: CMSCOPE changed --- modules/helptools/help/en_US/add_help_chapter.xml | 77 +++ modules/helptools/help/en_US/addchapter.sce | 11 + modules/helptools/help/en_US/apropos.xml | 77 +++ modules/helptools/help/en_US/del_help_chapter.xml | 59 ++ modules/helptools/help/en_US/help.xml | 72 +++ modules/helptools/help/en_US/help_from_sci.xml | 158 +++++ modules/helptools/help/en_US/help_skeleton.xml | 95 +++ modules/helptools/help/en_US/howtolinktoolbox.xml | 72 +++ modules/helptools/help/en_US/man.xml | 696 ++++++++++++++++++++++ modules/helptools/help/en_US/manedit.xml | 68 +++ modules/helptools/help/en_US/percenthelps.xml | 48 ++ modules/helptools/help/en_US/xmltohtml.xml | 120 ++++ modules/helptools/help/en_US/xmltojar.xml | 145 +++++ modules/helptools/help/en_US/xmltopdf.xml | 120 ++++ modules/helptools/help/en_US/xmltops.xml | 120 ++++ modules/helptools/help/fr_FR/addchapter.sce | 11 + modules/helptools/help/fr_FR/apropos.xml | 77 +++ modules/helptools/help/fr_FR/help.xml | 59 ++ modules/helptools/help/fr_FR/percenthelps.xml | 40 ++ modules/helptools/help/ja_JP/addchapter.sce | 11 + modules/helptools/help/pt_BR/add_help_chapter.xml | 70 +++ modules/helptools/help/pt_BR/addchapter.sce | 11 + modules/helptools/help/pt_BR/apropos.xml | 80 +++ modules/helptools/help/pt_BR/foo.xml | 83 +++ modules/helptools/help/pt_BR/help.xml | 63 ++ modules/helptools/help/pt_BR/help_from_sci.xml | 174 ++++++ modules/helptools/help/pt_BR/help_skeleton.xml | 92 +++ modules/helptools/help/pt_BR/manedit.xml | 68 +++ modules/helptools/help/pt_BR/percenthelps.xml | 98 +++ modules/helptools/help/pt_BR/xmltohtml.xml | 119 ++++ modules/helptools/help/pt_BR/xmltojar.xml | 144 +++++ modules/helptools/help/pt_BR/xmltopdf.xml | 119 ++++ modules/helptools/help/pt_BR/xmltops.xml | 119 ++++ modules/helptools/help/ru_RU/addchapter.sce | 11 + 34 files changed, 3387 insertions(+) create mode 100755 modules/helptools/help/en_US/add_help_chapter.xml create mode 100755 modules/helptools/help/en_US/addchapter.sce create mode 100755 modules/helptools/help/en_US/apropos.xml create mode 100755 modules/helptools/help/en_US/del_help_chapter.xml create mode 100755 modules/helptools/help/en_US/help.xml create mode 100755 modules/helptools/help/en_US/help_from_sci.xml create mode 100755 modules/helptools/help/en_US/help_skeleton.xml create mode 100755 modules/helptools/help/en_US/howtolinktoolbox.xml create mode 100755 modules/helptools/help/en_US/man.xml create mode 100755 modules/helptools/help/en_US/manedit.xml create mode 100755 modules/helptools/help/en_US/percenthelps.xml create mode 100755 modules/helptools/help/en_US/xmltohtml.xml create mode 100755 modules/helptools/help/en_US/xmltojar.xml create mode 100755 modules/helptools/help/en_US/xmltopdf.xml create mode 100755 modules/helptools/help/en_US/xmltops.xml create mode 100755 modules/helptools/help/fr_FR/addchapter.sce create mode 100755 modules/helptools/help/fr_FR/apropos.xml create mode 100755 modules/helptools/help/fr_FR/help.xml create mode 100755 modules/helptools/help/fr_FR/percenthelps.xml create mode 100755 modules/helptools/help/ja_JP/addchapter.sce create mode 100755 modules/helptools/help/pt_BR/add_help_chapter.xml create mode 100755 modules/helptools/help/pt_BR/addchapter.sce create mode 100755 modules/helptools/help/pt_BR/apropos.xml create mode 100755 modules/helptools/help/pt_BR/foo.xml create mode 100755 modules/helptools/help/pt_BR/help.xml create mode 100755 modules/helptools/help/pt_BR/help_from_sci.xml create mode 100755 modules/helptools/help/pt_BR/help_skeleton.xml create mode 100755 modules/helptools/help/pt_BR/manedit.xml create mode 100755 modules/helptools/help/pt_BR/percenthelps.xml create mode 100755 modules/helptools/help/pt_BR/xmltohtml.xml create mode 100755 modules/helptools/help/pt_BR/xmltojar.xml create mode 100755 modules/helptools/help/pt_BR/xmltopdf.xml create mode 100755 modules/helptools/help/pt_BR/xmltops.xml create mode 100755 modules/helptools/help/ru_RU/addchapter.sce (limited to 'modules/helptools/help') diff --git a/modules/helptools/help/en_US/add_help_chapter.xml b/modules/helptools/help/en_US/add_help_chapter.xml new file mode 100755 index 000000000..a1441d051 --- /dev/null +++ b/modules/helptools/help/en_US/add_help_chapter.xml @@ -0,0 +1,77 @@ + + + + + add_help_chapter + Add an entry in the help list + + + Calling Sequence + ok = add_help_chapter(title,path[,mode]) + + + Arguments + + + title + + String array, Help chapter title + + + + path + + String array, Help chapters path + + + + mode + + A boolean, if TRUE, the chapter is considered as belongs to a + internal modules, otherwise, the chapter is added as external module. + It is an optional input argument and its default value is %F. + + + + + ok + + A vector of booleans. The same size as + the path variable. If the chapter page + number i was not existing in the help system then ok(i) is + set to %t. + + + + + + + Description + + This function adds a new entry in the help list. If the path is already present + in the help list, add_help_chapter skips the add. The function + checks if the directory exist. + + + + See Also + + + help + + + del_help_chapter + + + + diff --git a/modules/helptools/help/en_US/addchapter.sce b/modules/helptools/help/en_US/addchapter.sce new file mode 100755 index 000000000..58e3b6e25 --- /dev/null +++ b/modules/helptools/help/en_US/addchapter.sce @@ -0,0 +1,11 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2009 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("Online help management",SCI+"/modules/helptools/help/en_US",%T); + diff --git a/modules/helptools/help/en_US/apropos.xml b/modules/helptools/help/en_US/apropos.xml new file mode 100755 index 000000000..5226a8541 --- /dev/null +++ b/modules/helptools/help/en_US/apropos.xml @@ -0,0 +1,77 @@ + + + + + apropos + searches keywords in Scilab help + + + Calling Sequence + apropos(key) + apropos(regexp) + + + + Arguments + + + key + + character string. give the sequence of characters to be found + + + + regexp + + character string. give the regular expression to be found + (only with "Scilab Browser") + + + + + + + Description + + apropos(key) looks for Scilab help files containing + keywords keyin their short description section. + + + apropos(regexp) looks for Scilab + help files containing regular expression regexpin their short + description section. + + + + Examples + + + + See Also + + + help + + + man + + + + diff --git a/modules/helptools/help/en_US/del_help_chapter.xml b/modules/helptools/help/en_US/del_help_chapter.xml new file mode 100755 index 000000000..1ce88c1bb --- /dev/null +++ b/modules/helptools/help/en_US/del_help_chapter.xml @@ -0,0 +1,59 @@ + + + + + del_help_chapter + Delete an entry in the help list + + + Calling Sequence + del_help_chapter(title[,mode]) + + + Arguments + + + title + + String array, Help chapter title + + + + mode + + A boolean, if TRUE, the chapter is considered as belongs to a + internal modules, otherwise, the chapter is removed. + It is an optional input argument and its default value is %F. + + + + + + + Description + + This function deletes an entry in the help list. + + + + See Also + + + help + + + add_help_chapter + + + + diff --git a/modules/helptools/help/en_US/help.xml b/modules/helptools/help/en_US/help.xml new file mode 100755 index 000000000..ec08a027a --- /dev/null +++ b/modules/helptools/help/en_US/help.xml @@ -0,0 +1,72 @@ + + + + + help + on-line help command + + + Calling Sequence + help(key) + help + + + + Arguments + + + key + + character string. The requested help page + + + + + + Description + + help without argument displays the hypertext page + containing the list of help chapters. + + + help(key) displays the Scilab help file associated with the + given key. If no help file is found, help(key) + automatically launches a search with the key word as search arguments. + + + See man for more explanation on how to write new help + pages . + + + + Examples + + + + + See Also + + + apropos + + + Scilab documentation format + + + + diff --git a/modules/helptools/help/en_US/help_from_sci.xml b/modules/helptools/help/en_US/help_from_sci.xml new file mode 100755 index 000000000..91b1584c3 --- /dev/null +++ b/modules/helptools/help/en_US/help_from_sci.xml @@ -0,0 +1,158 @@ + + + + + help_from_sci + Generate help files and demo files from the head comments section of a .sci source file. + + + Calling Sequence + + help_from_sci() // generate an empty function template + helptxt = help_from_sci() // generate an empty function template + help_from_sci(funname,helpdir) // generate helpdir/funname.xml from funname.sci. + help_from_sci(dirname,helpdir) // process dirname/*.sci and create helpdir/*.xml help files. + help_from_sci(dirname,helpdir,demodir) // as above but also creating demodir/*.dem.sce demo files. + [helptxt,demotxt]=help_from_sci(funname) // return funname.xml and funname.dem.sce code as two text matrixes. + + + + Parameters + + + funname: + + the name of a single .sci source file to be processed. + + + + dirname: + + directory name where all .sci files will be processed. + + + + helpdir: + + optional path where the .xml help file will be created. + + + + demodir: + + optional path where .dem.sce demo files will be created based on code from the Examples section. + + + + helptxt: + + returns the XML help code if helpdir is empty, or the path to the .xml file. + + + + demotxt: + + returns the demo code if demodir is empty, or the path to the .dem.sce file. + + + + + + Description + + The help_from_sci function generates .xml help files based on the head comments section + of .sci source files. Optionally .dem.sce demo files can be generated based on + code from the Examples section in the head comments section of .sci files. + + + In order for help_from_sci to format the .xml file properly the + head comments section should comply with some simple formatting rules. + + + The first comment line following the function definition should contain a short description + of the function. + + + The remaining comments are formatted according to the following (optional) headlines: + "Calling Sequence", "Parameters", "Description", "Examples", "See also", "Used functions", + "Authors" and "Bibliography". + + + The following guidelines should be used when writing the source code comments: + + + + Calling Sequence - one example pr. line. + + + + + Parameters - separate parameter name and + description by a ":". Keep the description of each parameter on the same line. + + + + + Description - formatting of the text can be done + using XML commands. Compare the output of head_comments("help_from_sci") with help("help_from_sci") + to get some hints. + Adding an empty comment line in the Description section is interpreted as the + start of a new paragraph. + + + + + See also - list one function name pr line. + + + + + Authors - write one author on each line following + the Authors headline. Use ";" to separate the authors name + from any add additional information. + + + + + Bibliography - write one reference pr line + following the References headline. + + + + + + + + + Examples + + + + See also + + + help + + + help_skeleton + + + head_comments + + + + diff --git a/modules/helptools/help/en_US/help_skeleton.xml b/modules/helptools/help/en_US/help_skeleton.xml new file mode 100755 index 000000000..0aab0a4f0 --- /dev/null +++ b/modules/helptools/help/en_US/help_skeleton.xml @@ -0,0 +1,95 @@ + + + + + help_skeleton + build the skeleton of the xml help file associated to a Scilab + function + + + + Calling Sequence + txt = help_skeleton(funname [,path [,language]]) + + + Arguments + + + funname + + character string : the name of the function + + + + path + + character string : the path where the file will be create if + required. If this argument is not given the skeleton is returned as + a string. + + + + + language + + character string :with possible value "fr_FR" or "en_US" the + defaultis "en_US" + + + + + txt + + the XML code or the complete XML file path + + + + + + + Description + + txt = help_skeleton(funname) generates a vector + of strings containing the skeleton of the XML code describing the help of + the function funname. + + + fullpath = help_skeleton(funname,dirpath) + generates the XML code describing the help of the function + funname in a file named funname.xml + in the directory specified by the path dirpath. In this + case the function returns the file path. + + + + Examples + 0)) then + editor(p); +end + ]]> + + + See Also + + + help + + + Scilab documentation format + + + + diff --git a/modules/helptools/help/en_US/howtolinktoolbox.xml b/modules/helptools/help/en_US/howtolinktoolbox.xml new file mode 100755 index 000000000..e0c8ac1f6 --- /dev/null +++ b/modules/helptools/help/en_US/howtolinktoolbox.xml @@ -0,0 +1,72 @@ + + + + + + Link toolbox help with Scilab one + How to make hyperlink in toolbox help pointing to Scilab's items + + + Description + Since Scilab 5.3.1, the hyperlinks in a toolbox help can be used to point on any help pages or to execute demos in the console. + + Now you can link a demo Uicontrol demo or execute a script about.sce + + + + Details + + + To link from two external modules, the syntax is: <link type="scilab" linkend="module_name.help/fun_in_module_name">fun_in_module_name</link> Usually, the name of the function is the id of the page. + + + To link from a external module to a Scilab function, the syntax is: <link type="scilab" linkend="scilab.help/bvode">bvode</link> Usually, the name of the function is the id of the page. + + + To enable the execution of a script, the syntax is: <link type="scilab" linkend="mytoolbox.exec/macros/fooexec.sce">macros/fooexec.sce</link> + + + To enable the execution of a demo, the syntax is: <link type="scilab" linkend="mytoolbox.demos/mydemo.dem">My demo</link> + + + + + Examples + + + + Foo + calculates foo + + + + Firstly a link on bvode in the Scilab Doc + + Secondly a link on My demo + + Thirdly a link on macros/fooexec.sce + + Fourthly a link on invalid link + + + + plot3d() // should link on plot3d + + + ]]> + + diff --git a/modules/helptools/help/en_US/man.xml b/modules/helptools/help/en_US/man.xml new file mode 100755 index 000000000..ec6a84779 --- /dev/null +++ b/modules/helptools/help/en_US/man.xml @@ -0,0 +1,696 @@ + + + + + Scilab documentation format + on line help XML file description format + + + Description + The on line help source files are written in XML. + Source files (with extension .xml) can be found in the + <SCIDIR>/modules/<MODULE + NAME>/help/<language>/* + + directories. The file name is + usually associated to a keyword (corresponding to a function name most of + the cases) it describes. + + + + A few words about XML + A XML file is similar to a HTML file but with a more rigid syntax. + The documentation of Scilab must be written using the strict subset of + DocBook 5 defined in SCI/modules/helptools/schema/scilab.rnc. DocBook 5 + elements are fully documented in "DocBook 5.0: The Definitive Guide" + + + Scilab is able to understand a large subset of Docbook tags. However, if any are missing, a bug report can be reported on the Scilab bug tracker. + + + + How to write a simple XML scilab help page: + If one want to write the XML file associated to a new scilab + function he or she may use the Scilab function help_skeleton to produce the skeleton of + the XML file. In most cases, the user will not be required to know XML + syntax. + + + + How to write a simple XML scilab help page: an example + The root element of a document which conforms to the Scilab DocBook + 5 subset must have version attribute set to "5.0-subset Scilab". + + + Example: + + Generated foo.xml in TMPDIR: + + + + How to create a help chapter + Create a directory and write down a set of XML files build as + described above. Then start Scilab and execute xmltojar + + (see xmltojar for more details) + . + + + + How to make Scilab know a new help chapter + + This can be done by the function add_help_chapter. + + + + List of docbook supported tags + Generic tags + + + + refentry + + A reference page + + + + section + + A recursive section + + + + book + + A book + + + + part + + A division in a book + + + + chapter + + A chapter, as of a book + + + + title + + The text of the title of a section of a document or of a formal block-level element + + + + para + + A paragraph + + + + literal + + Inline text that is some literal value + + + + refnamediv + + The name, purpose, and classification of a reference page + + + + refname + + The name of (one of) the subject(s) of a reference page + + + + refpurpose + + A short (one sentence) synopsis of the topic of a reference page + + + + refsynopsisdiv + + A syntactic synopsis of the subject of the reference page + + + + + synopsis + + A general-purpose element for representing the syntax of commands or functions + + + + refsection + + A recursive section in a refentry + + + + programlisting + + A literal listing of all or part of a program + + + + screen + + Text that a user sees or might see on a computer screen + + + + pubdate + + The date of publication of a document + + + + link + + A hypertext link + + + + ulink + + A link that addresses its target by means of a URL (Uniform Resource Locator) + + + + xref + + A cross reference to another part of the document + + + + term + + The word or phrase being defined or described in a variable list + + + + emphasis + + Emphasized text + + + + informalequation + + A displayed mathematical equation without a title + + + + + subscript + + + A subscript (as in H2O, the molecular formula for water) + + + + + superscript + + + A superscript (as in x2, the mathematical notation for x multiplied by itself) + + + + + replaceable + + Content that may or must be replaced by the user + + + + + caption + + A caption + + + + surname + + A family name; in western cultures the 'last name' + + + + firstname + + The first name of a person + + + + + bibliomset + + A 'cooked' container for related bibliographic information + + + + bibliomixed + + An entry in a Bibliography + + + + List tags: + + + + simplelist + + An undecorated list of single words or short phrases + + + + member + + An element of a simple list + + + + listitem + + A wrapper for the elements of a list item + + + + + varlistentry + + A wrapper for a set of terms and the associated description in a variable list + + + + variablelist + + A list in which each entry is composed of a set of one or more terms and an associated description + + + + itemizedlist + + A list in which each entry is marked with a bullet or other dingbat + + + + + orderedlist + + A list in which each entry is marked with a sequentially incremented label + + + + + Table tags: + + + + table + + A formal table in a document + + + + informaltable + + A table without a title + + + + tbody + + A wrapper for the rows of a table or informal table + + + + tr + + A row in an HTML table + + + + td + + A table entry in an HTML table + + + + th + + A table header entry in an HTML table + + + + bgcolor + + A HTML attribute for a table, a tr or a td to set the background color + + + + Image tags: + + + + imagedata + + Pointer to external image data + + + + imageobject + + A wrapper for image data and its associated meta-information + + + + inlinemediaobject + + An inline media object (video, audio, image, and so on) + + + + screenshot + + A representation of what the user sees or might see on a computer screen + + + + mediaobject + + A displayed media object (video, audio, image, etc.) + + + + scilab:image + + + Any Scilab code into the <scilab:image> foo() <scilab:image> will be executed by an instance of Scilab and the generated graphic included directly into the documentation. This is a Scilab extension of Docbook and is based on the driver/xinit/xend feature. + + + + + FAQ tags: + + + + question + + A question in a QandASet + + + + answer + + An answer to a question posed in a QandASet + + + + qandaentry + + A question/answer set within a QandASet + + + + qandaset + + A question-and-answer set + + + + History tags: + + + + revhistory + + A history of the revisions to a document + + + + revision + + An entry describing a single revision in the history of the revisions to a document + + + + revnumber + + A document revision number + + + + revremark + + A description of a revision to a document + + + + revdescription + + A extended description of a revision to a document + + + + + Information tags: + + + + note + + A message set off from the text + + + + + warning + + An admonition set off from the text + + + + caution + + A note of caution + + + + tip + + A suggestion to the user, set off from the text + + + + + important + + An admonition set off from the text + + + + Scilab specific tag: + + + latexScilab extension to write directly LaTeX expression in the help pages + + + + + + History + + + 5.4.0 + Management of tags <note>, <caution>, <warning>, <important> and <tip> + + + + + + See Also + + + apropos + + + help + + + help_skeleton + + + help_from_sci + + + xmltojar + + + add_help_chapter + + + + diff --git a/modules/helptools/help/en_US/manedit.xml b/modules/helptools/help/en_US/manedit.xml new file mode 100755 index 000000000..d13bfa689 --- /dev/null +++ b/modules/helptools/help/en_US/manedit.xml @@ -0,0 +1,68 @@ + + + + + manedit + editing a manual item + + + Calling Sequence + manedit(manitem) + + + Arguments + + + manitem + + character string (usually, name of a function) + + + + + + Description + + edit(manitem) opens the xml file associated to manitem + in the scilab editor. + + + If there is no xml file associated with manitem and + manitem is the name of a Scilab function, editor opens with + the skeleton of the xml file produced by help_skeleton. This + file is located in TMPDIR. + + + + Examples + + + + See Also + + + help + + + help_skeleton + + + + diff --git a/modules/helptools/help/en_US/percenthelps.xml b/modules/helptools/help/en_US/percenthelps.xml new file mode 100755 index 000000000..0a7580e5a --- /dev/null +++ b/modules/helptools/help/en_US/percenthelps.xml @@ -0,0 +1,48 @@ + + + + + %helps + Variable defining the path of help directories + + + Description + BEWARE: This variable must NOT be modified by users. + + The global variable %helps is an N x 2 matrix of strings. + The kth row of %helps, %helps(k,:) represents + the kth chapter of the manual and is made of two strings: + + + %helps(k,1) is the absolute pathname for a help directory. + + + %helps(k,2) is a title for this help directory. + + + To add a new help directory, the user should use add_help_chapter. + + + + See Also + + + add_help_chapter + + + help + + + + diff --git a/modules/helptools/help/en_US/xmltohtml.xml b/modules/helptools/help/en_US/xmltohtml.xml new file mode 100755 index 000000000..aaa25603e --- /dev/null +++ b/modules/helptools/help/en_US/xmltohtml.xml @@ -0,0 +1,120 @@ + + + + + xmltohtml + converts xml Scilab help files to HTML format + + + Calling Sequence + xmltohtml(dirs [,titles [,dir_language [default_language]]]]]) + + + Arguments + + + dirs + + vector of strings: a set of directory paths for which html + manuals are to be generated or [] + + + + + titles + + vector of strings: titles associated to directory paths or + [] + + + + + dir_language + + vector of strings: languages associated to directory paths or + [] + + + + + default_language + + vector of strings: default languages associated to directory + paths or []. If a XML file is missing in the dir_language, it's + copied from the default_language. + + + + + + + Description + converts xml Scilab help files contained in a set of directories + into HTML files. + + + + Examples + + + + + + See Also + + + help + + + add_help_chapter + + + + diff --git a/modules/helptools/help/en_US/xmltojar.xml b/modules/helptools/help/en_US/xmltojar.xml new file mode 100755 index 000000000..5babb6ce9 --- /dev/null +++ b/modules/helptools/help/en_US/xmltojar.xml @@ -0,0 +1,145 @@ + + + + + xmltojar + converts xml Scilab help files to javaHelp format + + + Calling Sequence + xmltojar(dirs [,titles [,dir_language [default_language]]]]]) + + + Arguments + + + dirs + + vector of strings: a set of directory paths for which html + manuals are to be generated or [] + + + + + titles + + vector of strings: titles associated to directory paths or + [] + + + + + dir_language + + vector of strings: languages associated to directory paths or + [] + + + + + default_language + + vector of strings: default languages associated to directory + paths or []. If a XML file is missing in the dir_language, it's + copied from the default_language. + + + + + + + Description + converts xml Scilab help files contained in a set of directories + into jar files. + + + + Examples + + + + + + See Also + + + help + + + add_help_chapter + + + + diff --git a/modules/helptools/help/en_US/xmltopdf.xml b/modules/helptools/help/en_US/xmltopdf.xml new file mode 100755 index 000000000..75a3e24c9 --- /dev/null +++ b/modules/helptools/help/en_US/xmltopdf.xml @@ -0,0 +1,120 @@ + + + + + xmltopdf + converts xml Scilab help files to pdf format + + + Calling Sequence + xmltopdf(dirs [,titles [,dir_language [default_language]]]]]) + + + Arguments + + + dirs + + vector of strings: a set of directory paths for which pdf + manuals are to be generated or [] + + + + + titles + + vector of strings: titles associated to directory paths or + [] + + + + + dir_language + + vector of strings: languages associated to directory paths or + [] + + + + + default_language + + vector of strings: default languages associated to directory + paths or []. If a XML file is missing in the dir_language, it's + copied from the default_language. + + + + + + + Description + converts xml Scilab help files contained in a set of directories + into pdf files. + + + + Examples + + + + + + See Also + + + help + + + add_help_chapter + + + + diff --git a/modules/helptools/help/en_US/xmltops.xml b/modules/helptools/help/en_US/xmltops.xml new file mode 100755 index 000000000..7329d4072 --- /dev/null +++ b/modules/helptools/help/en_US/xmltops.xml @@ -0,0 +1,120 @@ + + + + + xmltops + converts xml Scilab help files to postscript format + + + Calling Sequence + xmltops(dirs [,titles [,dir_language [default_language]]]]]) + + + Arguments + + + dirs + + vector of strings: a set of directory paths for which postscript + manuals are to be generated or [] + + + + + titles + + vector of strings: titles associated to directory paths or + [] + + + + + dir_language + + vector of strings: languages associated to directory paths or + [] + + + + + default_language + + vector of strings: default languages associated to directory + paths or []. If a XML file is missing in the dir_language, it's + copied from the default_language. + + + + + + + Description + converts xml Scilab help files contained in a set of directories + into ps files. + + + + Examples + + + + + + See Also + + + help + + + add_help_chapter + + + + diff --git a/modules/helptools/help/fr_FR/addchapter.sce b/modules/helptools/help/fr_FR/addchapter.sce new file mode 100755 index 000000000..58b48a6ae --- /dev/null +++ b/modules/helptools/help/fr_FR/addchapter.sce @@ -0,0 +1,11 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2009 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("Gestion de l''aide en ligne",SCI+"/modules/helptools/help/fr_FR",%T); + diff --git a/modules/helptools/help/fr_FR/apropos.xml b/modules/helptools/help/fr_FR/apropos.xml new file mode 100755 index 000000000..208eca998 --- /dev/null +++ b/modules/helptools/help/fr_FR/apropos.xml @@ -0,0 +1,77 @@ + + + + + apropos + recherche d'un mot-clé dans l'aide de Scilab + + + Séquence d'appel + apropos(key) + apropos(regexp) + + + + Paramètres + + + key + + Une chaîne de caractères, la séquence de caractères à rechercher + + + + regexp + + Une chaîne de caractères, l'expression régulière à + rechercher. Cette syntaxe ne fonctionne que le browser "Scilab Browser" + + + + + + + Description + + apropos(key) recherche les pages d'aides contenant la + séquence de caractères key dans leur section "SHORT_DESCRIPTION". + + + apropos(regexp) + recherche les pages d'aides contenant l'expression régulière donnée par + regexp dans leur section "SHORT_DESCRIPTION". + + + + Exemples + + + + Voir aussi + + + help + + + man + + + + diff --git a/modules/helptools/help/fr_FR/help.xml b/modules/helptools/help/fr_FR/help.xml new file mode 100755 index 000000000..0c9b84493 --- /dev/null +++ b/modules/helptools/help/fr_FR/help.xml @@ -0,0 +1,59 @@ + + + + + help + commande d'aide en ligne + + + Séquence d'appel + help(key) + + + Paramètres + + + key + + Une chaîne de caractères. Donne le nom de la page d'aide à visualiser. + + + + + + Description + + help sans argument, visualise la page hypertexte contenat la + liste des chapitres d'aide. + + + help(key) visualise la page d'aide associé avec le nom + donné par key. S'il n'y a pas de page d'aide, help(key) + appele automatiquement apropos(key). + + + Voir man pour apprendre à écrire de nouvelles pages d'aide. + + + + Voir aussi + + + apropos + + + man + + + + diff --git a/modules/helptools/help/fr_FR/percenthelps.xml b/modules/helptools/help/fr_FR/percenthelps.xml new file mode 100755 index 000000000..eadefa5b9 --- /dev/null +++ b/modules/helptools/help/fr_FR/percenthelps.xml @@ -0,0 +1,40 @@ + + + + + %helps + variable contenant les noms des répertoires des chapitres d'aide + + + Description + ATTENTION: Cette variable ne doit pas être modifiée manuellement par l'utilisateur. + + %helps est une matrice de chaînes de caractères à deux colonnes. Chaque ligne est formée comme ceci + + + + Pour ajouter de nouveaux chapitres d'aide, il faut utiliser la fonction add_help_chapter. + + + + Voir aussi + + + add_help_chapter + + + + diff --git a/modules/helptools/help/ja_JP/addchapter.sce b/modules/helptools/help/ja_JP/addchapter.sce new file mode 100755 index 000000000..f1760001d --- /dev/null +++ b/modules/helptools/help/ja_JP/addchapter.sce @@ -0,0 +1,11 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2009 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("Online help management",SCI+"/modules/helptools/help/ja_JP",%T); + diff --git a/modules/helptools/help/pt_BR/add_help_chapter.xml b/modules/helptools/help/pt_BR/add_help_chapter.xml new file mode 100755 index 000000000..7f67c4059 --- /dev/null +++ b/modules/helptools/help/pt_BR/add_help_chapter.xml @@ -0,0 +1,70 @@ + + + + + add_help_chapter + adiciona uma entrada na lista de ajudas + + + Seqüência de Chamamento + add_help_chapter(title,path[,mode]) + + + Parâmetros + + + title + + string, o título da ajuda + + + + path + + string, o endereço do diretório contendo os arquivos de + ajuda + + + + + mode + + booleano, %T se o diretório pertence à lista de módulos do + Scilab, %F em caso contrário (toolboxes). O valor padrão é + %F. + + + + + + + Descrição + Esta função adiciona uma nova entrada na lista de ajudas. Os + arquivos do capítulo de ajuda devem estar localizados em um único + diretório. Se o dado título title já existir na lista + de ajudas associado com o mesmo endereço, nada é feito. A função verifica + se o diretório existe. + + + + Ver Também + + + help + + + add_demo + + + + diff --git a/modules/helptools/help/pt_BR/addchapter.sce b/modules/helptools/help/pt_BR/addchapter.sce new file mode 100755 index 000000000..431bb3864 --- /dev/null +++ b/modules/helptools/help/pt_BR/addchapter.sce @@ -0,0 +1,11 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2009 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("Gerenciamento de ajuda online",SCI+"/modules/helptools/help/pt_BR",%T); + diff --git a/modules/helptools/help/pt_BR/apropos.xml b/modules/helptools/help/pt_BR/apropos.xml new file mode 100755 index 000000000..6106d47c4 --- /dev/null +++ b/modules/helptools/help/pt_BR/apropos.xml @@ -0,0 +1,80 @@ + + + + + apropos + procura por palavras-chave na ajuda do Scilab + + + Seqüência de Chamamento + apropos(key) + apropos(regexp) + + + + Parâmetros + + + key + + string. Fornece a seqüência de caracteres a ser + encontrada. + + + + + regexp + + string. Fornece a expressão regular a ser encontrada (apenas + com "Scilab Browser") + + + + + + + Descrição + + apropos(key) procura por arquivos de ajuda Scilab + contendo a palavra-chave key na seção de descrições + breves. + + + apropos(regexp) procura por arquivos de ajuda + Scilab contendo a expressão regular regexp na seção de + descrições breves. + + + + Exemplos + + + + Ver Também + + + help + + + man + + + + diff --git a/modules/helptools/help/pt_BR/foo.xml b/modules/helptools/help/pt_BR/foo.xml new file mode 100755 index 000000000..865430cbb --- /dev/null +++ b/modules/helptools/help/pt_BR/foo.xml @@ -0,0 +1,83 @@ + + + + + foo + descrição breve de foo + + + Seqüência de Chamamento + [y] = foo(x) + + + Parâmetros + + + x + + o que puder ser x + + + + y + + o que puder ser y + + + + + + Descrição + Um primeiro parárgrafo que explica o que a função foo computa. Se + quiser enfatizar um parâmetro, então você utiliza o seguinte tag + x, se quiser enfatizar parte do texto + encerre-o nestes tags e então utilize estes para obter uma fonte em negrito e finalmente + para um estilo em máquina de escrever. + + Um segundo parágrafo... Aqui está um exemplo de um link para outra + página : man. + + + + first + + parágrafo simples + + + + second + + toto é o foo francês... + + + + + + Exemplos + + + + Ver Também + + + man + + + apropos + + + + diff --git a/modules/helptools/help/pt_BR/help.xml b/modules/helptools/help/pt_BR/help.xml new file mode 100755 index 000000000..a554761d6 --- /dev/null +++ b/modules/helptools/help/pt_BR/help.xml @@ -0,0 +1,63 @@ + + + + + help + comando de ajuda on-line + + + Seqüência de Chamamento + help(key) + help + + + + Parâmetros + + + key + + string. Fornece a página de ajuda a ser encontrada + + + + + + Descrição + + help sem argumentos fornece a página de + hipertextos dos capítulos de ajuda. + + + help(key) exibe o arquivo de ajuda Scilab + associado ao dado key. Se nenhum arquivo for + encontrado, help(key) chama automaticamente + apropos(key). + + + Ver man para mais explicações sobre como + escrever novas páginas. + + + + Ver Também + + + apropos + + + man + + + + diff --git a/modules/helptools/help/pt_BR/help_from_sci.xml b/modules/helptools/help/pt_BR/help_from_sci.xml new file mode 100755 index 000000000..797ee180e --- /dev/null +++ b/modules/helptools/help/pt_BR/help_from_sci.xml @@ -0,0 +1,174 @@ + + + + + help_from_sci + Geração de arquivos de ajuda e de arquivos de demonstração a + partir da seção de comentários de cabeçalho de um arquivo-fonte + .sci + + + + Seqüência de Chamamento + + help_from_sci() // gera um modelo de função vazio + help_from_sci(funname,helpdir) // gera helpdir/funname.xml a partir de funname.sci + help_from_sci(dirname,helpdir) // processa dirname/*.sci e cria helpdir/*.xml. + help_from_sci(dirname,helpdir,helpdir) // como acima, mas também cria o arquivo de demonstração helpdir/*.dem.sce. + [helptxt,demotxt]=help_from_sci(funname) // retorna funname.xml e funname.dem.sce como duas matrizes de texto. + + + + Parâmetros + + + funname: + + o nome de um único arquivo .sci a ser processado + + + + dirname: + + nome do diretório onde todos os arquivos .sci serão + processados + + + + + helpdir: + + endereço opcional onde o arquivo de ajuda .xml será + criado + + + + + demodir: + + endereço opcional onde os arquivos de demonstração .dem.sce + serão criados baseados nos códigos da seção Examples + + + + + helptxt: + + retorna o código da ajuda XML se helpdir for vazio, ou o + endereço para o novo arquivo .xml + + + + + demotxt: + + retorna o código de demonstração se demodir for vazio, ou o + endereço para o novo arquivo .dem.sc + + + + + + + Descrição + help_from_sci é uma versão revisada da função help_skeleton. Seu + objetivo é gerar arquivos de ajuda .xml baseados na seção de comentários + de cabeçalho dos arquivos-fontes .sci. Opcionalmente, os arquivos de + demonstração .dem.sce podem ser gerados baseados nos códigos da seção + Examples na seção de cometários de cabeçalho dos arquivos .sci. + + Para que help_from_sci formate o arquivo .xml propriamente, os a + seção de comentários de cabeçalho deve concordar com algumas regras + simples de formatação. + + A primeira linha de comentário seguinte à definição de função deve + conter uma descrição breve da função. + + Os comentários restantes são formatados de acordo com os seguintes + cabeçalhos (opcionais): "Calling Sequence", "Parameters", "Description", + "Examples", "See also", "Used functions", "Authors" e + "Bibliography". + + As seguintes diretrizes devem ser seguidas ao se escrever os + comentários de código fonte: + + + + + Calling Sequence + - um exemplo por linha. + + + + + Parameters + - separe o nome do parâmetro e a descrição por um ":". Mantenha a descrição de cada parâmetro na mesma linha. + + + + + Description + - a formatação do texto pode ser feita utilizando comandos XML. Adicionar uma linha de comentário vazia na seção Description é interpretado como começo de um novo parágrafo. + + + + + See also + - liste um nome de função por linha. + + + + + Authors + - escreva um autor em cada linha após o cabeçalho Authors. Use ";" para separar os autores de qualquer informação adicional. + + + + + Bibliography + - escreva uma referência por linha seguindo o cabeçalho References. + + + + + + + Exemplos + + + + Ver Também + + + help + + + help_skeleton + + + xmltohtml + + + + diff --git a/modules/helptools/help/pt_BR/help_skeleton.xml b/modules/helptools/help/pt_BR/help_skeleton.xml new file mode 100755 index 000000000..9de8151ac --- /dev/null +++ b/modules/helptools/help/pt_BR/help_skeleton.xml @@ -0,0 +1,92 @@ + + + + + help_skeleton + constrói o esqueleto do arquivo de ajuda xml associado à + função Scilab + + + + Seqüência de Chamamento + txt = help_skeleton(funname [,path [,language]]) + + + Parâmetros + + + funname + + string : o nome da função + + + + path + + string : o endereço onde se criará o arquivo, se for + requerido. Se este argumento não for fornecido, o esqueleto é + retornado como um string. + + + + + language + + string :com valor possível "fr_FR" ou "en_US" o padrão é + "en_US" + + + + + txt + + o código xml ou o endereço do arquivo xml completo + + + + + + + Descrição + + txt = help_skeleton(funname) gera um vetor de + strings contendo o esqueleto do código XML descrevendo a ajuda da função + funname. + + + fullpath = help_skeleton(funname,dirpath) gera o + código XML descrevendo a ajuda da função funname em um + arquivo nomeado funname.xml no diretório especificado + pelo endereço dirpath. Neste caso, a função retorna o + endereço do arquivo. + + + + Exemplos + 0)) then + editor(p); +end + ]]> + + + Ver Também + + + help + + + + diff --git a/modules/helptools/help/pt_BR/manedit.xml b/modules/helptools/help/pt_BR/manedit.xml new file mode 100755 index 000000000..386ae59c2 --- /dev/null +++ b/modules/helptools/help/pt_BR/manedit.xml @@ -0,0 +1,68 @@ + + + + + manedit + editando item do manual + + + Seqüência de Chamamento + manedit(manitem) + + + Parâmetros + + + manitem + + string (geralmente, o nome de uma função) + + + + + + Descrição + + edit(manitem) abre o arquivo xml associado a + manitem no editor. + + + Se não há arquivo xml associado a manitem e + manitem é o nome de uma função Scilab, o scinotes abre + com o esqueleto do arquivo xml produzido por help_skeleton. Este arquivo está localizado + em TMPDIR. + + + + Exemplos + + + + Ver Também + + + help + + + help_skeleton + + + + diff --git a/modules/helptools/help/pt_BR/percenthelps.xml b/modules/helptools/help/pt_BR/percenthelps.xml new file mode 100755 index 000000000..93d8bebf3 --- /dev/null +++ b/modules/helptools/help/pt_BR/percenthelps.xml @@ -0,0 +1,98 @@ + + + + + %helps + variável definindo o endereço dos diretórios de + ajuda + + + + Descrição + + A variável global %helps é uma matriz N x 2 de + strings. A k-ésima linha de %helps, + %helps(k,:) representa o k-ésimo capítulo do manual e é + feita de dois strings: + + + %helps(k,1) é o nome de endereço absoluto de um + diretório. + + + %helps(k,2) é um título para este diretório. Por + exemplo, para k=2, nós temos o capítulo de gráficos + %helps(2,:). + + + A variável %helps é definida no arquivo de + inicialização do Scilab SCI+"/scilab.start". + + Para adicionar um novo diretório de ajuda, o usuário deve adicionar + uma linha a %helps. (Uma linha para cada + diretório). + + + Por exemplo, %helps=[%helps; + "Path-Of-My-Help-Dir","My-Title"]; + + habilita o navegador de ajuda + do Scilab a procurar por itens do manual de ajuda no diretório com + endereço "Path-Of-My-Help-Dir". + + "My-Title" é, então, o título do novo capítulo de ajuda. + Um diretório válido deve conter: + + 1- Um conjunto de arquivos.html (ex.: + item1.html, item2.html etc). Os arquivos + .html são geralmente construídos de arquivos + XML. + + + 2- Um arquivo whatis.html, que deve conter um + formato especial. Cada linha de whatis deve ser como + segue: + + item - rápida descrição + ]]> + + item é o item da ajuda, i.e. o comando + help item exibe o conteúdo do arquivo + item.html. + + + O comando apropos keyword retorna as linhas de + todos os arquivos whatis.html nos quais a palavra-chave + keyword aparece. + + Em plataformas Linux, o Scilab provê um Makefile para transformar + páginas .xml pages em páginas .html + (ver SCIDIR/examples/man-examples). + + + + Ver Também + + + apropos + + + help + + + man + + + + diff --git a/modules/helptools/help/pt_BR/xmltohtml.xml b/modules/helptools/help/pt_BR/xmltohtml.xml new file mode 100755 index 000000000..a98854f69 --- /dev/null +++ b/modules/helptools/help/pt_BR/xmltohtml.xml @@ -0,0 +1,119 @@ + + + + + xmltohtml + converte arquivos de ajuda xml do Scilab para formato + HTML + + + + Seqüência de Chamamento + xmltohtml(dirs [,titles [,dir_language [default_language]]]]]) + + + Parâmetros + + + dirs + + vetor de strings: um conjunto de endereços de diretórios para + os quais os manuais html devem ser gerados ou [] + + + + + + titles + + vetor de strings: títulos associados a endereços de diretórios + ou [] + + + + + dir_language + + vetor de strings: idiomas associados a endereços de diretórios + ou [] + + + + + default_language + + vetor de strings: idiomas padrões associados aos endereços de + diretórios ou []. Se um arquivo XML estiver faltando em + dir_language, ele é copiado de default_language. + + + + + + + Descrição + Converte arquivos de ajuda Scilab contidos em um conjunto de + diretórios para formato HTML. + + + + Exemplos + + + + Ver Também + + + help + + + add_help_chapter + + + + diff --git a/modules/helptools/help/pt_BR/xmltojar.xml b/modules/helptools/help/pt_BR/xmltojar.xml new file mode 100755 index 000000000..759573660 --- /dev/null +++ b/modules/helptools/help/pt_BR/xmltojar.xml @@ -0,0 +1,144 @@ + + + + + xmltojar + converte arquivos de ajuda xml do Scilab para formato + javaHelp + + + + Seqüência de Chamamento + xmltojar(dirs [,titles [,dir_language [default_language]]]]]) + + + Parâmetros + + + dirs + + vetor de strings: um conjunto de endereços de diretórios para + os quais os manuais html devem ser gerados ou [] + + + + + + titles + + vetor de strings: títulos associados a endereços de diretórios + ou [] + + + + + dir_language + + vetor de strings: idiomas associados a endereços de diretórios + ou [] + + + + + default_language + + vetor de strings: idiomas padrões associados aos endereços de + diretórios ou []. Se um arquivo XML estiver faltando em + dir_language, ele é copiado de default_language. + + + + + + + Descrição + Converte arquivos de ajuda Scilab contidos em um conjunto de + diretórios para formato jar. + + + + Exemplos + + + + Ver Também + + + help + + + add_help_chapter + + + + diff --git a/modules/helptools/help/pt_BR/xmltopdf.xml b/modules/helptools/help/pt_BR/xmltopdf.xml new file mode 100755 index 000000000..7c1e50ca5 --- /dev/null +++ b/modules/helptools/help/pt_BR/xmltopdf.xml @@ -0,0 +1,119 @@ + + + + + xmltopdf + converte arquivos de ajuda xml do Scilab para formato + PDF + + + + Seqüência de Chamamento + xmltopdf(dirs [,titles [,dir_language [default_language]]]]]) + + + Parâmetros + + + dirs + + vetor de strings: um conjunto de endereços de diretórios para + os quais os manuais pdf devem ser gerados ou [] + + + + + + titles + + vetor de strings: títulos associados a endereços de diretórios + ou [] + + + + + dir_language + + vetor de strings: idiomas associados a endereços de diretórios + ou [] + + + + + default_language + + vetor de strings: idiomas padrões associados aos endereços de + diretórios ou []. Se um arquivo XML estiver faltando em + dir_language, ele é copiado de default_language. + + + + + + + Descrição + Converte arquivos de ajuda Scilab contidos em um conjunto de + diretórios para formato PDF + + + + Exemplos + + + + Ver Também + + + help + + + add_help_chapter + + + + diff --git a/modules/helptools/help/pt_BR/xmltops.xml b/modules/helptools/help/pt_BR/xmltops.xml new file mode 100755 index 000000000..c5dcf7bca --- /dev/null +++ b/modules/helptools/help/pt_BR/xmltops.xml @@ -0,0 +1,119 @@ + + + + + xmltops + converte arquivos de ajuda xml do Scilab para formato + Postscript + + + + Seqüência de Chamamento + xmltops(dirs [,titles [,dir_language [default_language]]]]]) + + + Parâmetros + + + dirs + + vetor de strings: um conjunto de endereços de diretórios para + os quais os manuais postscript devem ser gerados ou [] + + + + + + titles + + vetor de strings: títulos associados a endereços de diretórios + ou [] + + + + + dir_language + + vetor de strings: idiomas associados a endereços de diretórios + ou [] + + + + + default_language + + vetor de strings: idiomas padrões associados aos endereços de + diretórios ou []. Se um arquivo XML estiver faltando em + dir_language, ele é copiado de default_language. + + + + + + + Descrição + Converte arquivos de ajuda Scilab contidos em um conjunto de + diretórios para formato PS. + + + + Exemplos + + + + Ver Também + + + help + + + add_help_chapter + + + + diff --git a/modules/helptools/help/ru_RU/addchapter.sce b/modules/helptools/help/ru_RU/addchapter.sce new file mode 100755 index 000000000..b6d39a61e --- /dev/null +++ b/modules/helptools/help/ru_RU/addchapter.sce @@ -0,0 +1,11 @@ +// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab +// Copyright (C) 2009 - DIGITEO +// +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt + +add_help_chapter("Online help management",SCI+"/modules/helptools/help/ru_RU",%T); + -- cgit