{"id":4209,"date":"2023-03-18T11:49:22","date_gmt":"2023-03-18T10:49:22","guid":{"rendered":"http:\/\/mosaic-modeling.de\/?page_id=4209"},"modified":"2023-08-22T09:57:26","modified_gmt":"2023-08-22T08:57:26","slug":"miscellaneous-documentation","status":"publish","type":"page","link":"https:\/\/mosaic-modeling.de\/?page_id=4209","title":{"rendered":"Miscellaneous: Documentation"},"content":{"rendered":"<div id=\"ez-toc-container\" class=\"ez-toc-v2_0_82_2 counter-hierarchy ez-toc-counter ez-toc-custom ez-toc-container-direction\">\n<div class=\"ez-toc-title-container\">\n<p class=\"ez-toc-title\" style=\"cursor:inherit\">On this page<\/p>\n<span class=\"ez-toc-title-toggle\"><a href=\"#\" class=\"ez-toc-pull-right ez-toc-btn ez-toc-btn-xs ez-toc-btn-default ez-toc-toggle\" aria-label=\"Toggle Table of Content\"><span class=\"ez-toc-js-icon-con\"><span class=\"\"><span class=\"eztoc-hide\" style=\"display:none;\">Toggle<\/span><span class=\"ez-toc-icon-toggle-span\"><svg style=\"fill: #999;color:#999\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" class=\"list-377408\" width=\"20px\" height=\"20px\" viewBox=\"0 0 24 24\" fill=\"none\"><path d=\"M6 6H4v2h2V6zm14 0H8v2h12V6zM4 11h2v2H4v-2zm16 0H8v2h12v-2zM4 16h2v2H4v-2zm16 0H8v2h12v-2z\" fill=\"currentColor\"><\/path><\/svg><svg style=\"fill: #999;color:#999\" class=\"arrow-unsorted-368013\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"10px\" height=\"10px\" viewBox=\"0 0 24 24\" version=\"1.2\" baseProfile=\"tiny\"><path d=\"M18.2 9.3l-6.2-6.3-6.2 6.3c-.2.2-.3.4-.3.7s.1.5.3.7c.2.2.4.3.7.3h11c.3 0 .5-.1.7-.3.2-.2.3-.5.3-.7s-.1-.5-.3-.7zM5.8 14.7l6.2 6.3 6.2-6.3c.2-.2.3-.5.3-.7s-.1-.5-.3-.7c-.2-.2-.4-.3-.7-.3h-11c-.3 0-.5.1-.7.3-.2.2-.3.5-.3.7s.1.5.3.7z\"\/><\/svg><\/span><\/span><\/span><\/a><\/span><\/div>\n<nav><ul class='ez-toc-list ez-toc-list-level-1 ' ><li class='ez-toc-page-1 ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-1\" href=\"https:\/\/mosaic-modeling.de\/?page_id=4209\/#Purpose\" >Purpose<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-2\" href=\"https:\/\/mosaic-modeling.de\/?page_id=4209\/#Explanation-of-the-editor\" >Explanation of the editor<\/a><\/li><\/ul><\/nav><\/div>\n<p>MOSAICmodeling has been developed with the aim of linking modeling and simulation with the documentation of the model. This aim is supported by the documentation feature.<\/p>\n<h3><span class=\"ez-toc-section\" id=\"Purpose\"><\/span>Purpose<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<p>The documentation feature allows the user to automatically generate LaTeX code based on any of the MOSAICmodeling elements. This means that you can directly export your model after you have completed your simulations, e.g., because you want to publish the model, use it in your thesis, etc.<\/p>\n<h3><span class=\"ez-toc-section\" id=\"Explanation-of-the-editor\"><\/span>Explanation of the editor<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<p>The documentation feature is shown below in Figure 1. Basically, you select the model element you want to export, e.g., an equation, an equation system, a variable specification, or a simulation. Afterwards, you set the type of export (see Table 1), and copy the code into your LaTeX document.<\/p>\n<figure id=\"attachment_4999\" aria-describedby=\"caption-attachment-4999\" style=\"width: 1680px\" class=\"wp-caption alignnone\"><a href=\"http:\/\/mosaic-modeling.de\/wp-content\/uploads\/2023\/08\/Editor_Documentation.png\"><img loading=\"lazy\" decoding=\"async\" class=\"size-full wp-image-4999\" src=\"http:\/\/mosaic-modeling.de\/wp-content\/uploads\/2023\/08\/Editor_Documentation.png\" alt=\"\" width=\"1680\" height=\"1050\" srcset=\"https:\/\/mosaic-modeling.de\/wp-content\/uploads\/2023\/08\/Editor_Documentation.png 1680w, https:\/\/mosaic-modeling.de\/wp-content\/uploads\/2023\/08\/Editor_Documentation-300x188.png 300w, https:\/\/mosaic-modeling.de\/wp-content\/uploads\/2023\/08\/Editor_Documentation-1024x640.png 1024w, https:\/\/mosaic-modeling.de\/wp-content\/uploads\/2023\/08\/Editor_Documentation-768x480.png 768w, https:\/\/mosaic-modeling.de\/wp-content\/uploads\/2023\/08\/Editor_Documentation-1536x960.png 1536w\" sizes=\"auto, (max-width: 1680px) 100vw, 1680px\" \/><\/a><figcaption id=\"caption-attachment-4999\" class=\"wp-caption-text\">Figure: Documentation feature of MOSAICmodeling.<\/figcaption><\/figure>\n\n\n<figure class=\"wp-block-table is-style-stripes has-small-font-size\"><table><thead><tr><th class=\"has-text-align-center\" data-align=\"center\">Element<\/th><th class=\"has-text-align-left\" data-align=\"left\">Explanation<\/th><\/tr><\/thead><tbody><tr><td class=\"has-text-align-center\" data-align=\"center\">Location<\/td><td class=\"has-text-align-left\" data-align=\"left\">File you want to export, i.e., equation, equation system, simulation, etc.<\/td><\/tr><tr><td class=\"has-text-align-center\" data-align=\"center\">Option<\/td><td class=\"has-text-align-left\" data-align=\"left\">Allows the user specific options, e.g., whether generic or instantiated equations shall be exported<\/td><\/tr><tr><td class=\"has-text-align-center\" data-align=\"center\">Export selection<\/td><td class=\"has-text-align-left\" data-align=\"left\">Depends on the type of the loaded MOSAICmodeling element. In the case of a simulation, the user can select which part of the simulation shall be exported &#8211; all files or only a specific element, such as the equation system<\/td><\/tr><tr><td class=\"has-text-align-center\" data-align=\"center\">LaTex style<\/td><td class=\"has-text-align-left\" data-align=\"left\">Allows the selection of a couple of different export types, e.g., framed equations.<\/td><\/tr><tr><td class=\"has-text-align-center\" data-align=\"center\">Generate<\/td><td class=\"has-text-align-left\" data-align=\"left\">Generates the LaTeX code according to the set options<\/td><\/tr><\/tbody><\/table><figcaption class=\"wp-element-caption\">Table 1: Elements of the documentation feature.<\/figcaption><\/figure>\n","protected":false},"excerpt":{"rendered":"<p>MOSAICmodeling has been developed with the aim of linking modeling and simulation with the documentation of the model. This aim is supported by the documentation feature. Purpose The documentation feature allows the user to automatically generate LaTeX code based on any of the MOSAICmodeling elements. This means that you can directly export your model after [&hellip;]<\/p>\n","protected":false},"author":252,"featured_media":0,"parent":4206,"menu_order":2,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-4209","page","type-page","status-publish","czr-hentry"],"_links":{"self":[{"href":"https:\/\/mosaic-modeling.de\/index.php?rest_route=\/wp\/v2\/pages\/4209","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/mosaic-modeling.de\/index.php?rest_route=\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/mosaic-modeling.de\/index.php?rest_route=\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/mosaic-modeling.de\/index.php?rest_route=\/wp\/v2\/users\/252"}],"replies":[{"embeddable":true,"href":"https:\/\/mosaic-modeling.de\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=4209"}],"version-history":[{"count":6,"href":"https:\/\/mosaic-modeling.de\/index.php?rest_route=\/wp\/v2\/pages\/4209\/revisions"}],"predecessor-version":[{"id":5695,"href":"https:\/\/mosaic-modeling.de\/index.php?rest_route=\/wp\/v2\/pages\/4209\/revisions\/5695"}],"up":[{"embeddable":true,"href":"https:\/\/mosaic-modeling.de\/index.php?rest_route=\/wp\/v2\/pages\/4206"}],"wp:attachment":[{"href":"https:\/\/mosaic-modeling.de\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=4209"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}