OpenSimulationInterface · philipwindecker · Oct 11, 2022 · Sep 15, 2022 · Sep 15, 2022 · Oct 6, 2022
diff --git a/.gitignore b/.gitignore
@@ -2,6 +2,7 @@
 *.adoc1
 *.adoc2
 site/
+pdf/
 0_used-keywords.adoc
 *.pyc
 .vscode/settings.json

diff --git a/README.adoc b/README.adoc
@@ -63,4 +63,36 @@ However, there exists a workaround:
 If they are already in your workspace, remove them from there.
 . Next, add the innermost repository (the content repositories) to your workspace first.
 . Then, continue outwards until you added the uppermost repository (the generator).
+====
+
+
+=== Local PDF builder
+IMPORTANT: This only works for a local setup!
+
+.Click for local PDF builder setup instructions
+[%collapsible]
+====
+To build Antora into PDF (which only works locally right now), you have to change a few settings.
+
+First, enter your link:docker-compose-local.yml[docker-compose-local.yml] file, comment out the line below `Default generator setup`, then comment in the line below `BE AWARE that this currently does not support the use of (C) or (R)! You must alter the respective lines in osi-documentation/.antora/antora.yml. Make sure not to check these changes in!`.
+
+Next, open the 'antora.yml' file in your 'osi-documentation/.antora' folder and change the following lines from
+
+[source,yaml]
+----
+THIS_STANDARD: ASAM OSI<sup>®</sup> # Normal attribute
+THIS_STANDARD_TITLE: 'ASAM OSI^®^' # Normal attribute
+# THIS_STANDARD: ASAM OSI # PDF version attribute
+# THIS_STANDARD_TITLE: 'ASAM OSI' # PDF version attribute
+----
+
+to
+
+[source,yaml]
+----
+# THIS_STANDARD: ASAM OSI<sup>®</sup> # Normal attribute
+# THIS_STANDARD_TITLE: 'ASAM OSI^®^' # Normal attribute
+THIS_STANDARD: ASAM OSI # PDF version attribute
+THIS_STANDARD_TITLE: 'ASAM OSI' # PDF version attribute
+----
 ====
diff --git a/antora-assembler.yml b/antora-assembler.yml
@@ -0,0 +1,8 @@
+root_level: 0
+component_versions: '*'
+# asciidoc:
+#   attributes:
+#     source-highlighter: rouge
+    # pdf-theme: ./pdf-theme.yml
+build:
+  dir: "./pdf"  
diff --git a/asam-antora-extensions b/asam-antora-extensions
diff --git a/docker-compose-local.yml b/docker-compose-local.yml
@@ -10,8 +10,15 @@ services:
       - kroki
       - blockdiag
       - mermaid
+    ## Run interactively
     # entrypoint: /bin/bash
-    entrypoint: antora --stacktrace --fetch --clean site_local.yml
+
+    ## Run with PDF generator. 
+    ## BE AWARE that this currently does not support the use of (C) or (R)! You must alter the respective lines in osi-documentation/.antora/antora.yml. Make sure not to check these changes in!
+    # entrypoint: antora --stacktrace --clean --extension @antora/pdf-extension site_local.yml # This creates a pdf on top of the html output. BE AWARE that this currently does not support the use of (C) or (R)! You must alter the respective lines in osi-documentation/.antora/antora.yml. Make sure not to check these changes in!
+
+    ## Default generator setup
+    entrypoint: antora --stacktrace --clean site_local.yml
 
 
   kroki:

diff --git a/site.yml b/site.yml
@@ -13,19 +13,19 @@ content:
   sources:
     - url: https://github.com/OpenSimulationInterface/osi-documentation.git # retrieve content from remote
     # - url: ./osi-documentation # retrieve content locally
-      branches: [antora/base-antora-setup] # osi-documentation -- change to main later
+      branches: [master] # osi-documentation
       # branches: HEAD # build current HEAD
       tags: [v*,"!v1*", "!v3.5.0"]
       start_path: .antora
     - url: https://github.com/OpenSimulationInterface/open-simulation-interface.git # retrieve content from remote
     # - url: ./open-simulation-interface# retrieve content locally
-      branches: [antora/base-antora-setup] # open-simulation-interface -- change to main later
+      branches: [master] # open-simulation-interface
       # branches: HEAD # build current HEAD
       tags: [v*,"!v2*", "!v3.0*", "!v3.1*", "!v3.2*", "!v3.3*", "!v3.4*", "!v3.5.0"]
       start_path: .antora
     - url: https://github.com/OpenSimulationInterface/osi-sensor-model-packaging.git # retrieve content from remote
     # - url: ./osi-sensor-model-packaging # retrieve content locally
-      branches: [antora/base-antora-setup] # osi-sensor-model-packaging -- change to main later
+      branches: [master] # osi-sensor-model-packaging
       # branches: HEAD # build current HEAD
       tags: [v*,"!v0*", "!v1.0*", "!v1.1*", "!v1.2*", "!v1.3.0"]
       start_path: .antora
@@ -85,7 +85,6 @@ asciidoc:
 
   extensions:
   - asciidoctor-kroki
-  # - '@djencks/asciidoctor-mathjax'
   - './asam-antora-extensions/asam-asciidoctor_extensions-registered.js'
   - './asam-antora-extensions/asam-asciidoctor_extensions.js'
 # end::asciidoctor[]

diff --git a/supplemental_ui/css/extra.css b/supplemental_ui/css/extra.css
@@ -0,0 +1,19 @@
+.navbar-brand {
+    display: -webkit-box;
+    display: -ms-flexbox;
+    display: flex;
+    -webkit-box-flex: 1;
+    -ms-flex: auto;
+    flex: auto;
+    padding-left: 1rem;
+    min-width: fit-content;
+}
+
+
+@media screen and (max-width: 1023px){
+.navbar-end {
+    display: -webkit-box;
+    display: -ms-flexbox;
+    display: flex;
+    justify-content: center;
+}}
diff --git a/supplemental_ui/partials/footer-content.hbs b/supplemental_ui/partials/footer-content.hbs
@@ -1,4 +1,4 @@
 <footer class="footer">
   <p>This standard is licensed under the 
-    <a href="https://www.asam.net/license">ASAM license terms</a>.</p>
+    <a href="https://github.com/OpenSimulationInterface/open-simulation-interface/blob/master/LICENSE">MPL v2.0</a>.</p>
 </footer>
diff --git a/supplemental_ui/partials/head-meta.hbs b/supplemental_ui/partials/head-meta.hbs
@@ -11,4 +11,5 @@
 <script type="text/javascript" async
   src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.9/MathJax.js?config=TeX-MML-AM_CHTML">
 </script>
-<link rel="stylesheet" href="{{uiRootPath}}/css/iframe.css">
+<link rel="stylesheet" href="{{uiRootPath}}/css/iframe.css">
+<link rel="stylesheet" href="{{uiRootPath}}/css/extra.css">
diff --git a/supplemental_ui/partials/header-content.hbs b/supplemental_ui/partials/header-content.hbs
@@ -7,35 +7,17 @@
           {{#unless (eq page.componentVersion.displayVersion "master")}}{{#unless (eq page.layout '404')}} –
           {{page.componentVersion.displayVersion}}{{/unless}}{{/unless}}</a>
       </div>
-      {{#if env.SITE_SEARCH_PROVIDER}}
+    </div>
+    <div class="navbar-end">
       <div class="navbar-item search hide-for-print">
-        <div id="search-field" class="field">
-          <input id="search-input" type="text" placeholder="Search the docs"{{#if page.home}} autofocus{{/if}}>
-        </div>
+        {{#if env.SITE_SEARCH_PROVIDER}}
+          <div id="search-field" class="field">
+            <input id="search-input" type="text" placeholder="Search the docs"{{#if page.home}} autofocus{{/if}}>
+          </div>
+        {{/if}}
       </div>
-      {{/if}}
-    </div>
-    <div class="navbar-item menu hide-for-print">
       <div id="topbar-nav" class="navbar-menu">
-        <div class="navbar-end">
-          <a class="navbar-item" href="#">To top</a>
-          <div class="navbar-item is-hoverable">
-            {{#if page.attributes.feedbackurl}}
-              {{#if page.attributes.feedbackcontent}}
-                <a class="navbar-item" href="{{page.attributes.feedbackurl}}?{{page.attributes.feedbackcontent}}--%3E%0D%0A%7C%20%7C%20%7C%0D%0A%7C---%7C---%7C%0D%0A%7C%20URL%20%7C%20{{site.url}}{{page.url}}%20%7C%0D%0A%7C%20Page%20%7C%20{{page.title}}%20%7C%0D%0A%7C%20Module%20%7C%20{{page.module}}%20%7C" title="Click here to submit feedback on this page">Submit feedback</a>
-              {{else}}
-                {{#if page.attributes.feedbacktype}}
-                  {{#if (eq page.attributes.feedbacktype 'gitlab')}}
-                    <a class="navbar-item" href="{{page.attributes.feedbackurl}}?subject=Review%20feedback:%20%3Ctopic%20summary%3E&amp;body=%23%23%20Subject%0D%0A%3CAdd%20title%20of%20topic%3E%0D%0A%0D%0A%23%23%20Section%20%0D%0A%3CAdd%20section%20here%3E%0D%0A%0D%0A%23%23%20Description%20%0D%0A%3CAdd%20feedback%20here%3E%0D%0A%3C%20Recommended%3A%20Add%20a%20screenshot%20of%20the%20part%20you%20want%20to%20comment%20on%3E%0D%0A%0D%0A%23%23%20Suggestion%0D%0A%3C%20Add%20a%20suggestion%20or%20things%20you%20want%20to%20change%20after%20this%3E%0D%0A%0D%0A%3C%21--%20The%20following%20content%20was%20automatically%20added.%20DO%20NOT%20CHANGE%20--%3E%0D%0A%7C%20%7C%20%7C%0D%0A%7C---%7C---%7C%0D%0A%7C%20URL%20%7C%20{{site.url}}{{page.url}}%20%7C%0D%0A%7C%20Page%20%7C%20{{page.title}}%20%7C%0D%0A%7C%20Module%20%7C%20{{page.module}}%20%7C" title="Click here to submit feedback on this page">Submit feedback</a>
-                  {{/if}}
-                  {{#if (eq page.attributes.feedbacktype 'github')}}
-                    <a class="navbar-item" href="{{page.attributes.feedbackurl}}?labels=new;title=Content+feedback:+;body=%23+Prerequisites%0D%0A%0D%0AThis+is+in+regards+to%3A%0D%0A%0D%0A-+%5B+%5D+Title%0D%0A-+%5B+%5D+Content%3A+Text%0D%0A-+%5B+%5D+Content%3A+Image%28s%29%0D%0A-+%5B+%5D+Formatting%0D%0A-+%5B+%5D+Location+in+Project+Guide%0D%0A-+%5B+%5D+Obsolete%0D%0A%0D%0A%23+Subject%0D%0A%3C%21--+%3CAdd+title+of+topic%3E+--%3E%0D%0A%0D%0A%23+Section%0D%0A%3C%21--+%3CAdd+section+here%3E++--%3E%0D%0A%0D%0A%23+Description%0D%0A%3C%21--+%3CAdd+feedback+here%3E+--%3E%0D%0A%3C%21--+%3C+Recommended%3A+Add+a+screenshot+of+the+part+you+want+to+comment+on%3E+--%3E%0D%0A%0D%0A%23+Suggestion%0D%0A%3C%21--+%3C+Add+a+suggestion+or+things+you+want+to+change+after+this%3E+--%3E%0D%0A%0D%0A%3C%21--+If+added+manually%2C+please+fill+in+the+following+table+with+URL+%3D+page+url%2C+Page+%3D+the+name+of+the+page.+You+can+leave+Module+open+--%3E%0D%0A%7C+%7C+%7C%0D%0A%7C---%7C---%7C%0D%0A%7C+URL+%7C+{{site.url}}{{page.url}}+%7C%0D%0A%7C+Page+%7C+{{page.title}}+%7C%0D%0A%7C+Module+%7C+{{page.module}}+%7C" title="Click here to submit feedback on this page">Submit feedback</a>
-                  {{/if}}
-                {{/if}}
-              {{/if}}
-            {{/if}}
-          </div>
-        </div>
+        <a class="navbar-item" href="#">To top</a>
         {{#if page.attributes.download-links}}
           <div class="navbar-item has-dropdown is-hoverable">
             <a class="navbar-link" href="#">Additional resources</a>
@@ -50,6 +32,32 @@
             </div>
           </div>
         {{/if}}
+        {{#if page.attributes.repository-links}}
+          <div class="navbar-item has-dropdown is-hoverable">
+            <a class="navbar-link" href="#">Repositories</a>
+            <div class="navbar-dropdown">
+              {{# each page.attributes.repository-links}}
+                <a class="navbar-item" href="{{this.[0]}}" target="_blank">{{this.[1]}}</a>
+              {{/each}}
+            </div>
+          </div>
+        {{/if}}
+        <div class="navbar-item is-hoverable">
+          {{#if page.attributes.feedbackurl}}
+            {{#if page.attributes.feedbackcontent}}
+              <a class="navbar-item" href="{{page.attributes.feedbackurl}}?{{page.attributes.feedbackcontent}}--%3E%0D%0A%7C%20%7C%20%7C%0D%0A%7C---%7C---%7C%0D%0A%7C%20URL%20%7C%20{{site.url}}{{page.url}}%20%7C%0D%0A%7C%20Page%20%7C%20{{page.title}}%20%7C%0D%0A%7C%20Module%20%7C%20{{page.module}}%20%7C" title="Click here to submit feedback on this page">Submit feedback</a>
+            {{else}}
+              {{#if page.attributes.feedbacktype}}
+                {{#if (eq page.attributes.feedbacktype 'gitlab')}}
+                  <a class="navbar-item" href="{{page.attributes.feedbackurl}}?subject=Review%20feedback:%20%3Ctopic%20summary%3E&amp;body=%23%23%20Subject%0D%0A%3CAdd%20title%20of%20topic%3E%0D%0A%0D%0A%23%23%20Section%20%0D%0A%3CAdd%20section%20here%3E%0D%0A%0D%0A%23%23%20Description%20%0D%0A%3CAdd%20feedback%20here%3E%0D%0A%3C%20Recommended%3A%20Add%20a%20screenshot%20of%20the%20part%20you%20want%20to%20comment%20on%3E%0D%0A%0D%0A%23%23%20Suggestion%0D%0A%3C%20Add%20a%20suggestion%20or%20things%20you%20want%20to%20change%20after%20this%3E%0D%0A%0D%0A%3C%21--%20The%20following%20content%20was%20automatically%20added.%20DO%20NOT%20CHANGE%20--%3E%0D%0A%7C%20%7C%20%7C%0D%0A%7C---%7C---%7C%0D%0A%7C%20URL%20%7C%20{{site.url}}{{page.url}}%20%7C%0D%0A%7C%20Page%20%7C%20{{page.title}}%20%7C%0D%0A%7C%20Module%20%7C%20{{page.module}}%20%7C" title="Click here to submit feedback on this page">Submit feedback</a>
+                {{/if}}
+                {{#if (eq page.attributes.feedbacktype 'github')}}
+                  <a class="navbar-item" href="{{page.attributes.feedbackurl}}?labels=new;title=Content+feedback:+;body=%23+Prerequisites%0D%0A%0D%0AThis+is+in+regards+to%3A%0D%0A%0D%0A-+%5B+%5D+Title%0D%0A-+%5B+%5D+Content%3A+Text%0D%0A-+%5B+%5D+Content%3A+Image%28s%29%0D%0A-+%5B+%5D+Formatting%0D%0A-+%5B+%5D+Location+in+Project+Guide%0D%0A-+%5B+%5D+Obsolete%0D%0A%0D%0A%23+Subject%0D%0A%3C%21--+%3CAdd+title+of+topic%3E+--%3E%0D%0A%0D%0A%23+Section%0D%0A%3C%21--+%3CAdd+section+here%3E++--%3E%0D%0A%0D%0A%23+Description%0D%0A%3C%21--+%3CAdd+feedback+here%3E+--%3E%0D%0A%3C%21--+%3C+Recommended%3A+Add+a+screenshot+of+the+part+you+want+to+comment+on%3E+--%3E%0D%0A%0D%0A%23+Suggestion%0D%0A%3C%21--+%3C+Add+a+suggestion+or+things+you+want+to+change+after+this%3E+--%3E%0D%0A%0D%0A%3C%21--+If+added+manually%2C+please+fill+in+the+following+table+with+URL+%3D+page+url%2C+Page+%3D+the+name+of+the+page.+You+can+leave+Module+open+--%3E%0D%0A%7C+%7C+%7C%0D%0A%7C---%7C---%7C%0D%0A%7C+URL+%7C+{{site.url}}{{page.url}}+%7C%0D%0A%7C+Page+%7C+{{page.title}}+%7C%0D%0A%7C+Module+%7C+{{page.module}}+%7C" title="Click here to submit feedback on this page">Submit feedback</a>
+                {{/if}}
+              {{/if}}
+            {{/if}}
+          {{/if}}
+        </div>
       </div>
     </div>
   </nav>
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,6 +2,7 @@ @@
     *.adoc1
     *.adoc2
     site/
+    pdf/
 _used-keywords.adoc
     *.pyc
     .vscode/settings.json
@@ Expand Down @@