diff --git a/about/contribute/documentation/cvs.en.tm b/about/contribute/documentation/cvs.en.tm index 21aed3d..6a9cc5e 100644 --- a/about/contribute/documentation/cvs.en.tm +++ b/about/contribute/documentation/cvs.en.tm @@ -1,15 +1,15 @@ - + <\body> - > + > The present documentation is currently maintained on - using (Concurrent Version System). In - order to contribute, you should first create an account as explained on + using . In order to contribute, you should + first create an account as explained on - > + > In fact, the system is not ideal for our documentation purpose, because it is not very dynamic. In the future, we plan to create a @@ -29,18 +29,6 @@ <\initial> <\collection> - - - - - - - - - - - - \ No newline at end of file diff --git a/about/contribute/documentation/documentation.en.tm b/about/contribute/documentation/documentation.en.tm index f428c86..5ec9b50 100644 --- a/about/contribute/documentation/documentation.en.tm +++ b/about/contribute/documentation/documentation.en.tm @@ -1,9 +1,9 @@ - + <\body> - documentation> + documentation> There is a high need for good documentation on as well as people who are willing to translate the existing documentation into other @@ -12,45 +12,31 @@ documentation. <\traverse> - + - |using cvs|cvs.en.tm> + |cvs.en.tm> - + - + - + - + - + - + <\initial> <\collection> - - - - - - - - - - - - - + \ No newline at end of file diff --git a/about/contribute/documentation/file-names.en.tm b/about/contribute/documentation/file-names.en.tm index cdea21a..19dabeb 100644 --- a/about/contribute/documentation/file-names.en.tm +++ b/about/contribute/documentation/file-names.en.tm @@ -1,25 +1,20 @@ - + <\body> - + Most documentation should be organized as a function of the topic in a directory tree. The subdirectories of the top directory are the following: <\description> - Documentation for developers. + Various information about the system (authors, + changes, ). - Examples of documents. + Documentation for developers. - Incoming documentation, which is still a bit - experimental. - - The main documentation. - - How to write documentation and the compilation of - documentation. + The main documentation. Please try to keep the number of entries per directory reasonably small. @@ -31,11 +26,9 @@ following: <\description> - Documentation for advanced users. + For inclusion in the manual. - For inclusion in the manual. - - For inclusion in the tutorial. + For inclusion in the tutorial. You should try to keep the documentation on the same topic together, @@ -49,30 +42,18 @@ should not be translated as . - + - + <\initial> <\collection> - - - - - - - - - - - - - + \ No newline at end of file diff --git a/about/contribute/documentation/introduction.en.tm b/about/contribute/documentation/introduction.en.tm index 17f3f5d..63d9ef5 100644 --- a/about/contribute/documentation/introduction.en.tm +++ b/about/contribute/documentation/introduction.en.tm @@ -1,4 +1,4 @@ - + @@ -11,9 +11,7 @@ enough examples and illustrative screen shots whenever adequate. Although the documentation is not necessarily meant to be complete, we do aim at providing relatively stable documentation. In particular, you should have - checked your text against spelling errors. The more experimental - documentation should be put in the directory or on the - Wiki|http://alqua.com/tmresources>. + checked your text against spelling errors. It is also important that you give your documentation as much structure as possible, using special markup from the style file. This @@ -21,9 +19,9 @@ from your documentation, to make it suitable for different ways of viewing, or to make it possible to efficiently search a certain type of information in the documentation. In particular, you should always provide - information, - as well as indications on how to your - documentation, if it contains . + information, as + well as indications on how to your + documentation, if it contains . <\warning> Don't forget to select for each diff --git a/about/contribute/documentation/tmdoc-style.en.tm b/about/contribute/documentation/tmdoc-style.en.tm index 96cc3c7..aea6b5c 100644 --- a/about/contribute/documentation/tmdoc-style.en.tm +++ b/about/contribute/documentation/tmdoc-style.en.tm @@ -1,40 +1,38 @@ - + <\body> - + - Besides the macros - and , which have been - documented before, the style comes with a certain number of - other macros and functions, which you should use whenever appropriate: + Besides the macros and + , which have been documented + before, the style comes with a certain number of other + macros and functions, which you should use whenever appropriate: <\description> - >This macro is used to indicate keyboard input - like . The specialized macros , - , , , - , , , - and are used for keyboard input corresponding to a - specific type of action or mode. For instance, - corresponds to keyboard shortcuts for mathematical operations, such as - , which starts a fraction. + >This macro is used to indicate a keyboard + shortcut for a command. For instance, the shortcut for + is . - >This function with an arbitrary number of - arguments indicates a menu like or - . Menu entries are automatically translated - by this function. + >This unary macro is used for explicit keyboard input. + For instance, when giving > as argument, + the result is . - >This macro is used in order to indicate a - macro or a function like . + >This function with an arbitrary number of arguments + indicates a menu like or . Menu + entries are automatically translated by this function. - >This macro indicates the name of a - style file or package like . + >This macro is used in order to indicate a macro or + a function like . - >This macro indicates the name of a - package like . + >This macro indicates the name of a + style file or package like . - >This macro indicates the name of a + >This macro indicates the name of a + package like . + + >This macro indicates the name of a like . @@ -49,270 +47,66 @@ purposes, although they should be improved in the future: <\description> - >This macro takes an URL - as argument and is a hyperlink with name and - destination . + >This macro takes an URL as argument + and is a hyperlink with name and destination . - >This macro is a usual hyperlink. + >This macro is a usual hyperlink. - >This macro takes a concept as - argument. Later on an appropriate hyperlink might be created - automatically from this and the other documentation. + >This macro takes a concept as argument. + Later on an appropriate hyperlink might be created automatically from + this and the other documentation. - >Index a simple string. + >Index a simple string. - >Definition of a new concept; the text is + >Definition of a new concept; the text is printed in italic and indexed. - >Reappearance of an already defined - concept; the text is printed in roman and put in the index. + >Reappearance of an already defined concept; the + text is printed in roman and put in the index. The following tags are also frequently used: <\description> - >Link to an icon in a central directory like - . + >The language. - >Link to a screenshot. The actual - screenshots are stored in a central directory like - . + >The language. - >The language. + >For displaying a piece of code in a nice + frame. - >The language. + >Single out a fragment of a + document. - >For displaying a piece of code in - a nice frame. + >For multi-paragraph code. - >For multi-paragraph - code. + >For multi-paragraph code. - >For multi-paragraph code. + >For a short piece of code. - >For a piece of markup code - in format. + >For a short piece of code. - >For a short piece of - code. - - >For a short piece of code. - - >For descriptive tables; such - tables can be used to document lists of keyboard shortcuts, different - types of markup, + >For descriptive tables; such tables can + be used to document lists of keyboard shortcuts, different types of + markup, The style inherits from the style and you should use macros like , , , from this style whenever appropriate. - + - + <\initial> <\collection> - - - - - - - - - - - - - - -<\references> - <\collection> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - |?>> - - - -<\auxiliary> - <\collection> - <\associate|idx> - |color||tmdoc>>|> - - |color||key>>|> - - |color||kbd-gen>>|> - - |color||kbd-text>>|> - - |color||kbd-math>>|> - - |color||kbd-symb>>|> - - |color||kbd-big>>|> - - |color||kbd-large>>|> - - |color||kbd-ia>>|> - - |color||kbd-exec>>|> - - |color||kbd-table>>|> - - |color||kbd-math>>|> - - |color||menu>>|> - - |File>>|> - - |Document>||Language>>|> - - |color||markup>>|> - - |color||section>>|> - - |color||tmstyle>>|> - - |color||article>>|> - - |color||tmpackage>>|> - - |color||std-markup>>|> - - |color||tmdtd>>|> - - |color||number-env>>|> - - |color||simple-link>>|> - - |color||hyper-link>>|> - - |color||concept-link>>|> - - |color||only-index>>|> - - |color||def-index>>|> - - |color||re-index>>|> - - |color||icon>>|> - - |color||screenshot>>|> - - |color||scheme>>|> - - |color||framed-fragment>>|> - - |color||scheme-fragment>>|> - - |color||cpp-fragment>>|> - - |color||tm-fragment>>|> - - |color||scheme-code>>|> - - |color||cpp-code>>|> - - |color||descriptive-table>>|> - - |color||tmdoc>>|> - - |color||generic>>|> - - |color||em>>|> - - |color||verbatim>>|> - - |color||itemize>>|> - - - + \ No newline at end of file