data/asciidoc/html.conf

   1 [attributes]
   2 foam-xhtml11=1
   3 # Version 8.5 through 8.6.4 use asciidoc-xhtml11.js, after that asciidoc.js.
   4 # Test whether asciidoc version > 8.6.4. assume major version is 8 since only
   5 # interested in versions from 8.5 anyways, older ones won't work.
   6 asciidoc_js=asciidoc-xhtml11.js
   7 ifeval::[int("{asciidoc-version}".split(".")[1])>6 or (int("{asciidoc-version}".split(".")[1])==6 and int("{asciidoc-version}".split(".")[2])>4)]
   8 asciidoc_js=asciidoc.js
   9 foam-use-new-files=
  10 endif::[]
  11
  12 include::common.conf[]
  13
  14 [macros]
  15 (?su)(?P<name>download_links):(?P<target>[^\[]+)\[\]=[]
  16
  17 [linkrepo-inlinemacro]
  18 <a
  19   {target$^openfoam$:}href="http://repo.or.cz/w/OpenFOAM-1.5.x.git?a=commit;h={commitId}"
  20   {target$^openfoam17$:}href="https://github.com/OpenCFD/OpenFOAM-1.7.x/commit/{commitId}"
  21   {target$^freefoam$:}href="http://repo.or.cz/w/freefoam.git?a=commit;h={commitId}"
  22 >{commitId}</a>
  23
  24 [linkff-inlinemacro]
  25 <a href="../man{manvolnum}/{target}.{manvolnum}.html">{target}{manvolnum?({manvolnum})}</a>
  26
  27 [math-inlinemacro]
  28 {foam-use-pngmath,imageref%}\({passtext}\)
  29 {foam-use-pngmath+imageref#}<img src="{imageref}" alt="{passtext}"/>
  30
  31 [mathblock-template]
  32 <div class="mathblock{role? {role}}"{id? id="{id}"}>
  33 <div class="content">
  34 <div class="title">{title}</div>
  35 {foam-use-pngmath,imageref%}{passtext}
  36 {foam-use-pngmath+imageref#}<img src="{imageref}" alt="{passtext}"/>
  37 </div></div>
  38
  39 [math-blockmacro]
  40 template::[mathblock-template]
  41
  42 [mathblock]
  43 {set:passtext:|}
  44 template::[mathblock-template]
  45
  46 [menuselection-inlinemacro]
  47 <span class="menuchoice"><span class="guimenu">{menuname}</span>
  48 {menuitems#}&#8594;{eval:'&#8594;'.join(map(lambda s: '<span class="guimenuitem">'+s.strip()+'</span>', '{menuitems}'.split('-&#8594;')))}
  49 </span>
  50
  51 [diskitem-inlinemacro]
  52 <span  class="{name@dir:directory:file}">{passtext}</span>
  53
  54 [option-inlinemacro]
  55 <span class="option">{passtext}</span>
  56
  57 [guiitem-inlinemacro]
  58 <span class="{name}">{passtext}</span>
  59
  60 [download_links-inlinemacro]
  61 <a href="{basedown}/{target}/freefoam-{target}.tar.bz2/download">freefoam-{target}.tar.bz2</a>
  62 (<a href="{basedown}/{target}/freefoam-{target}.tar.bz2.md5/download">md5</a>
  63 <a href="{basedown}/{target}/freefoam-{target}.tar.bz2.sha1/download">sha1</a>
  64 <a href="{basedown}/{target}/freefoam-{target}.tar.bz2.sig/download">GPG</a>)
  65
  66
  67 [header]
  68 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
  69     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
  70 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
  71   <head>
  72     <meta http-equiv="Content-Type" content="text/html; charset={encoding}" />
  73     <meta name="generator" content="AsciiDoc {asciidoc-version}" />
  74 ifdef::index-only[]
  75     <meta name="description" content="The Cross-Platform CFD Toolkit" />
  76     <meta name="description" content="FreeFOAM is an open-source, cross-platform Toolkit for Computational Fluid Dynamics (CFD) based on OpenFOAM (R)." />
  77     <meta name="keywords" content="FreeFOAM, Computational Fluid Dynamics, CFD, C++, Open Source" />
  78 endif::index-only[]
  79 ifdef::linkcss[]
  80     <link rel="stylesheet" href="{stylesdir={eval:CONF_DIR}/stylesheets}/{theme={foam-use-new-files?asciidoc}{foam-use-new-files!{backend}}}.css" type="text/css" />
  81     <link rel="stylesheet" href="{foam-stylesdir={docdir}/doc/css}/layout.css" type="text/css" />
  82 endif::linkcss[]
  83 ifndef::linkcss[]
  84     <style type="text/css">
  85 include1::{stylesdir={eval:CONF_DIR}/stylesheets}/{theme={foam-use-new-files?asciidoc}{foam-use-new-files!{backend}}}.css[]
  86 include1::{foam-stylesdir={docdir}/doc/css}/layout.css[]
  87     </style>
  88 endif::linkcss[]
  89 # only for asciidoc-generated files, don't include in Doxygen header
  90     <style type="text/css"> <!--
  91       a, a:visited, a:visited:hover { color: #d40000; text-decoration: none; }
  92     --> </style>
  93     <script type="text/javascript">/*<![CDATA[*/
  94       window.onload = function()\{asciidoc.footnotes();{toc? asciidoc.toc({toclevels});}\}
  95     /*]]>*/
  96 ifdef::linkcss[]
  97     </script>
  98     <script type="text/javascript" src="{scriptsdir={eval:CONF_DIR}/javascripts}/{asciidoc_js}"></script>
  99 endif::linkcss[]
 100 ifndef::linkcss[]
 101 include1::{scriptsdir={eval:CONF_DIR}/javascripts}/{asciidoc_js}[]
 102     /*]]>*/</script>
 103 endif::linkcss[]
 104 ifdef::foam-use-mathjax[]
 105 # never include1::[] MathJax.js, that wouldn't work
 106     <script type="text/javascript"
 107       src="{foam-mathjax-url=http://cdn.mathjax.org/mathjax/latest}/MathJax.js?config=default"/>
 108 ifdef::linkcss[]
 109     <script type="text/javascript" src="{foam-scriptsdir={docdir}/doc/js}/MathJaxMacros.js"/>
 110 endif::linkcss[]
 111 ifndef::linkcss[]
 112     <script type="text/javascript">/*<![CDATA[*/
 113 include1::{foam-scriptsdir={docdir}/doc/js}/MathJaxMacros.js[]
 114 /*]]>*/</script>
 115 endif::linkcss[]
 116 endif::foam-use-mathjax[]
 117     <meta name="source_file" content="{docfile}" />
 118     <title>{doctitle}</title>
 119   </head>
 120   <body>
 121     <div id="layout-banner-box">
 122       <div id="layout-banner">
 123         <a href="{homepage}/index.html">
 124         <img id="layout-title" alt="FreeFOAM"
 125 {data-uri%}src="{imagesdir={docdir}/doc/img}/FreeFOAMLogo.png"/>
 126 {data-uri#}src="data:image/png;base64,
 127 {data-uri#}{sys:python -uc "import base64,sys; base64.encode(open('{imagesdir={docdir}/doc/img}/FreeFOAMLogo.png'),sys.stdout)"}"/>
 128         </a>
 129         <img id="layout-description" alt="The Cross-Platform CFD Toolkit"
 130 {data-uri%}src="{imagesdir={docdir}/doc/img}/CrossPlatformToolkit.png"/>
 131 {data-uri#}src="data:image/png;base64,
 132 {data-uri#}{sys:python -uc "import base64,sys; base64.encode(open('{imagesdir={docdir}/doc/img}/CrossPlatformToolkit.png'),sys.stdout)"}"/>
 133       </div>
 134     </div>
 135     <div id="layout-menu-box">
 136       <div id="layout-menu">
 137         <ul>
 138           <li><a href="{homepage}/index.html"{index-only? class="current_page"}>Home</a></li>
 139           <li><a href="{homepage}/downloads/index.html"{docfile@.*/downloads/: class="current_page"}>Downloads</a></li>
 140           <li><a href="{homepage}/documentation.html"{docfile@.*/documentation.txt: class="current_page"}>Documentation</a></li>
 141 ifdef::docs-only[]
 142           <li>
 143             <ul>
 144               <li><a href="{rel-doc}/INSTALL.html"{docfile@.*INSTALL: class="current_page"}>Installation</a></li>
 145               <li><a href="{foam-have-ug,foam-doc-for_sf?{rel-doc}}{foam-have-ug={homepage}/doc/v{fullver}}/UserGuide/index.html">
 146                 User&nbsp;Guide</a></li>
 147               <li><a href="{foam-have-man,foam-doc-for-sf?{rel-doc}}{foam-have-man={homepage}/doc/v{fullver}}/man/man1/freefoam.1.html">
 148                 man-pages</a></li>
 149               <li><a href="{foam-have-doxy,foam-doc-for_sf?{rel-doc}}{foam-have-doxy={homepage}/doc/v{fullver}}/API/index.html">
 150                 API&nbsp;Documentation</a></li>
 151               <li><a href="{rel-doc}/README.html"{docfile@.*README: class="current_page"}>README</a></li>
 152               <li><a href="{rel-doc}/ReleaseNotes.html"{docfile@.*ReleaseNotes: class="current_page"}>Release Notes</a></li>
 153               <li><a href="{rel-doc}/ChangeLog.html"{docfile@.*ChangeLog: class="current_page"}>Changes</a></li>
 154               <li><a href="{rel-doc}/COPYING.html"{docfile@.*COPYING: class="current_page"}>License</a></li>
 155             </ul>
 156           </li>
 157 endif::docs-only[]
 158           <li><a href="{homepage}/support.html"{docfile@.*support.txt: class="current_page"}>Support</a></li>
 159           <li><a href="http://www.sourceforge.net/projects/freefoam">SourceForge Project</a></li>
 160         </ul>
 161       </div>
 162 ifdef::foam-doc-for_sf[]
 163       <div id="layout-sf">
 164         Hosted by SourceForge:<br />
 165         <a href="http://sourceforge.net/projects/freefoam">
 166           <img
 167             src="http://sflogo.sourceforge.net/sflogo.php?group_id=215833&amp;type=12"
 168             width="120" height="30" alt="Get FreeFOAM at SourceForge.net. Fast, secure and
 169             Free Open Source software downloads" />
 170         </a>
 171       </div>
 172 endif::foam-doc-for_sf[]
 173     </div>
 174     <div id="layout-content-box">
 175       <div id="layout-content">
 176 # Article, book header.
 177         <div id="header">
 178           <h1>{doctitle}</h1>
 179           <span id="author">{author}</span><br />
 180           <span id="email"><tt>&lt;<a href="mailto:{email}">{email}</a>&gt;</tt></span><br />
 181           {authored}<span id="revision">version {revnumber}{revdate?,}</span>
 182           {authored}{revdate}
 183         </div>
 184 ifdef::toc[{template:toc}]
 185         <div id="content">
 186
 187 [footer]
 188         </div>
 189         <div id="footnotes"><hr /></div>
 190         <div id="footer">
 191           <div id="footer-text">
 192             Version {revnumber}<br/>
 193             Last updated {localdate} {localtime}<br/>
 194             Copyright &copy; 2008-{eval:time.strftime('%Y\n')} Michael Wild and Gerber van der Graaf
 195           </div>
 196         </div>
 197       </div>
 198     </div>
 199   </body>
 200 </html>
 201
 202 #
 203 #
 204 # vim: ft=conf sw=2 expandtab fenc=utf-8 :