| |||||||||||||||||||||||||
Using moseldoc Description
mosel moseldoc -- mddoc.bimwhere the BIM file to which it is applied (here: mddoc.bim) must have been compiled specifying the option '-D'. Note that if no filename is specified moseldoc will display a help text and terminate with an error. It is possible to use wildcards such as '*.bim' meaning all bim files in current directory. Alternatively, the program can be turned into an executable using 'deploy' with the command (requires a C compiler): mosel comp -s moseldoc.mos -o deploy.exe:moseldocThe resulting program expects as its parameters a list of files: moseldoc mddoc.bimWhen compiling moseldoc, the 'datablock' functionality is used to include some styles file for the webpage layout. The provided set of files also contains the dictionary template (.pot) generated with the xprnls tool and sets of translations for German and French. The file 'mddoc.mos' contains examples of using the 'doc' annotations markup and a detailed description of the functionality available through moseldoc. Processing this file with one of the commands shown above will generate the documentation for moseldoc. Further explanation of this example: 'Mosel Language Reference', Section 2.19 Documenting models using annotations and 'Mosel User Guide', Section 18.2 moseldoc: Generating model documentation.
Source Files By clicking on a file name, a preview is opened at the bottom of this page.
Data Files
load-mathjax.js // File load-mathjax.js // -- Mathjax configuration for Xpress HTML documentation -- // // Copyright (c) 2021 Fair Isaac Corporation. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // window.MathJax = { tex: { inlineMath: [['\\(', '\\)']], tags: 'ams', // enable eq numbering macros: { bbbr: "{\\rm I\\! R}", bbbn: "{\\rm I\\! N}", amp: "&", tamp: "\&" // table column separator } }, }; (function () { var script = document.createElement('script'); script.src = 'https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml.js'; script.async = true; document.head.appendChild(script); })(); | |||||||||||||||||||||||||
© Copyright 2024 Fair Isaac Corporation. |