Blame templates/html/htmllayout.tpl

Packit 1c1d7e
{% msg %}----- Start generating HTML output for {{ config.PROJECT_NAME }} from template ----{% endmsg %}
Packit 1c1d7e
Packit 1c1d7e
{# ---- copy fixed resources to the output ----- #}
Packit 1c1d7e
Packit 1c1d7e
{% resource 'doxygen.css' %}
Packit 1c1d7e
{% resource 'tabs.css' %}
Packit 1c1d7e
{% resource 'jquery.js' %}
Packit 1c1d7e
{% resource 'dynsections.js %}
Packit 1c1d7e
{% resource 'tab_a.lum' %}
Packit 1c1d7e
{% resource 'tab_b.lum' %}
Packit 1c1d7e
{% resource 'tab_h.lum' %}
Packit 1c1d7e
{% resource 'tab_s.lum' %}
Packit 1c1d7e
{% resource 'tab_h.lum' %}
Packit 1c1d7e
{% resource 'bc_s.luma' %}
Packit 1c1d7e
{% resource 'doxygen.luma' %}
Packit 1c1d7e
{% resource 'closed.luma' %}
Packit 1c1d7e
{% resource 'open.luma' %}
Packit 1c1d7e
{% resource 'bdwn.luma' %}
Packit 1c1d7e
{% resource 'sync_on.luma' %}
Packit 1c1d7e
{% resource 'sync_off.luma' %}
Packit 1c1d7e
Packit 1c1d7e
{# navigation #}
Packit 1c1d7e
{% resource 'nav_f.lum' %}
Packit 1c1d7e
{% resource 'nav_g.png' %}
Packit 1c1d7e
{% resource 'nav_h.lum' %}
Packit 1c1d7e
{% resource 'navtree.css' %}
Packit 1c1d7e
{% resource 'navtree.js' %}
Packit 1c1d7e
{% resource 'resize.js' %}
Packit 1c1d7e
{% resource 'menu.js' %}
Packit 1c1d7e
{% resource 'doc.luma' %}
Packit 1c1d7e
{% resource 'folderopen.luma' %}
Packit 1c1d7e
{% resource 'folderclosed.luma' %}
Packit 1c1d7e
{% resource 'splitbar.lum' %}
Packit 1c1d7e
Packit 1c1d7e
{# general search resources #}
Packit 1c1d7e
{% resource 'search_l.png' as 'search/search_l.png' %}
Packit 1c1d7e
{% resource 'search_m.png' as 'search/search_m.png' %}
Packit 1c1d7e
{% resource 'search_r.png' as 'search/search_r.png' %}
Packit 1c1d7e
{% if config.DISABLE_INDEX %}
Packit 1c1d7e
  {% resource 'search_noidx.css' as 'search/search.css'   %}
Packit 1c1d7e
{% else %}
Packit 1c1d7e
  {% resource 'search.css'       as 'search/search.css'   %}
Packit 1c1d7e
{% endif %}
Packit 1c1d7e
Packit 1c1d7e
{% if config.SERVER_BASED_SEARCH %}
Packit 1c1d7e
  {# server side search resources #}
Packit 1c1d7e
  {% resource 'mag.png'     as 'search/mag.png'     %}
Packit 1c1d7e
  {% resource 'extsearch.js as 'search/search.js'   %}
Packit 1c1d7e
  {% resource 'search_functions.php'  as 'search/search_functions.php'  %}
Packit 1c1d7e
  {% resource 'search_opensearch.php' as 'search/search_opensearch.php' %}
Packit 1c1d7e
{% else %}
Packit 1c1d7e
  {# client side search resources #}
Packit 1c1d7e
  {% resource 'mag_sel.png' as 'search/mag_sel.png' %}
Packit 1c1d7e
  {% resource 'close.png'   as 'search/close.png'   %}
Packit 1c1d7e
  {% resource 'search.js'   as 'search/search.js'   %}
Packit 1c1d7e
{% endif %}
Packit 1c1d7e
Packit 1c1d7e
{# interactive SVGs #}
Packit 1c1d7e
{% resource 'svgpan.js' %}
Packit 1c1d7e
Packit 1c1d7e
{# -------------------------------------------------- #}
Packit 1c1d7e
Packit 1c1d7e
{# global constants #}
Packit 1c1d7e
{% set maxItemsForFlatList=30 %}
Packit 1c1d7e
{% set maxItemsForMultiPageList=200 %}
Packit 1c1d7e
Packit 1c1d7e
{# global variable #}
Packit 1c1d7e
{% set page_postfix='' %}
Packit 1c1d7e
Packit 1c1d7e
{# open the global navigation index #}
Packit 1c1d7e
{% indexentry nav name=tr.mainPage file='index' anchor='' isReference=False %}
Packit 1c1d7e
{% opensubindex nav %}
Packit 1c1d7e
Packit 1c1d7e
{# ----------- HTML DOCUMENTATION PAGES ------------ #}
Packit 1c1d7e
Packit 1c1d7e
{# write main page documentation #}
Packit 1c1d7e
{% with page=mainPage compound=mainPage isMainPage=True %}
Packit 1c1d7e
  {% create mainPage.fileName|append:config.HTML_FILE_EXTENSION from 'htmlpage.tpl' %}
Packit 1c1d7e
{% endwith %}
Packit 1c1d7e
Packit 1c1d7e
{# write namespace documentation pages #}
Packit 1c1d7e
{% for compound in namespaceList %}
Packit 1c1d7e
  {% with page=compound %}
Packit 1c1d7e
    {% create compound.fileName|append:config.HTML_FILE_EXTENSION from 'htmlnamespace.tpl' %}
Packit 1c1d7e
  {% endwith %}
Packit 1c1d7e
{% endfor %}
Packit 1c1d7e
Packit 1c1d7e
{# write class documentation pages #}
Packit 1c1d7e
{% for compound in classList %}
Packit 1c1d7e
  {% with page=compound %}
Packit 1c1d7e
    {% create compound.fileName|append:config.HTML_FILE_EXTENSION from 'htmlclass.tpl' %}
Packit 1c1d7e
    {% if compound.allMembersList and not config.OPTIMIZE_OUTPUT_FOR_C %}
Packit 1c1d7e
      {% create compound.allMembersFileName|append:config.HTML_FILE_EXTENSION from 'htmlallmembers.tpl' %}
Packit 1c1d7e
    {% endif %}
Packit 1c1d7e
  {% endwith %}
Packit 1c1d7e
{% endfor %}
Packit 1c1d7e
Packit 1c1d7e
{# write the file sources #}
Packit 1c1d7e
{% for compound in fileList %}
Packit 1c1d7e
  {% with page=compound %}
Packit 1c1d7e
    {# TODO: to deal with clang optimisation, we need to write the sources in a different order! #}
Packit 1c1d7e
    {% if compound.hasSourceFile %}
Packit 1c1d7e
      {% create compound.sourceFileName|append:config.HTML_FILE_EXTENSION from 'htmlsource.tpl' %}
Packit 1c1d7e
    {% endif %}
Packit 1c1d7e
  {% endwith %}
Packit 1c1d7e
{% endfor %}
Packit 1c1d7e
Packit 1c1d7e
{# write file documentation pages #}
Packit 1c1d7e
{% for compound in fileList %}
Packit 1c1d7e
  {% with page=compound %}
Packit 1c1d7e
    {% create compound.fileName|append:config.HTML_FILE_EXTENSION from 'htmlfile.tpl' %}
Packit 1c1d7e
  {% endwith %}
Packit 1c1d7e
{% endfor %}
Packit 1c1d7e
Packit 1c1d7e
{# write related page documentation #}
Packit 1c1d7e
{% for compound in pageList %}
Packit 1c1d7e
  {% with page=compound isMainPage=False %}
Packit 1c1d7e
    {% create compound.fileName|append:config.HTML_FILE_EXTENSION from 'htmlpage.tpl' %}
Packit 1c1d7e
  {% endwith %}
Packit 1c1d7e
{% endfor %}
Packit 1c1d7e
Packit 1c1d7e
{# write module documentation #}
Packit 1c1d7e
{% for compound in moduleList %}
Packit 1c1d7e
  {% with page=compound %}
Packit 1c1d7e
    {% create compound.fileName|append:config.HTML_FILE_EXTENSION from 'htmlmodule.tpl' %}
Packit 1c1d7e
  {% endwith %}
Packit 1c1d7e
{% endfor %}
Packit 1c1d7e
Packit 1c1d7e
{# write example documentation #}
Packit 1c1d7e
{% for compound in exampleList %}
Packit 1c1d7e
  {% with page=compound %}
Packit 1c1d7e
    {% create compound.fileName|append:config.HTML_FILE_EXTENSION from 'htmlexample.tpl' %}
Packit 1c1d7e
  {% endwith %}
Packit 1c1d7e
{% endfor %}
Packit 1c1d7e
Packit 1c1d7e
{# ----------- INDEXES ------------ #}
Packit 1c1d7e
Packit 1c1d7e
{# --- related pages --- #}
Packit 1c1d7e
{% if pageTree.tree %}
Packit 1c1d7e
  {% with page=pageTree %}
Packit 1c1d7e
    {% create pageTree.fileName|append:config.HTML_FILE_EXTENSION from 'htmlpages.tpl' %}
Packit 1c1d7e
  {% endwith %}
Packit 1c1d7e
{% endif %}
Packit 1c1d7e
Packit 1c1d7e
{# ---- examples --- #}
Packit 1c1d7e
{% if exampleTree.tree %}
Packit 1c1d7e
  {% with page=exampleTree %}
Packit 1c1d7e
    {% create exampleTree.fileName|append:config.HTML_FILE_EXTENSION from 'htmlexamples.tpl' %}
Packit 1c1d7e
  {% endwith %}
Packit 1c1d7e
{% endif %}
Packit 1c1d7e
Packit 1c1d7e
{# --- modules --- #}
Packit 1c1d7e
{% if moduleTree.tree %}
Packit 1c1d7e
  {% with page=moduleTree %}
Packit 1c1d7e
    {% create moduleTree.fileName|append:config.HTML_FILE_EXTENSION from 'htmlmodules.tpl' %}
Packit 1c1d7e
  {% endwith %}
Packit 1c1d7e
{% endif %}
Packit 1c1d7e
Packit 1c1d7e
{# --- namespaces --- #}
Packit 1c1d7e
{% if namespaceList %}
Packit 1c1d7e
  {% indexentry nav name=tr.namespaces file='' anchor='' isReference=False %}
Packit 1c1d7e
  {% opensubindex nav %}
Packit 1c1d7e
Packit 1c1d7e
  {% if namespaceTree.tree %}
Packit 1c1d7e
    {% with page=namespaceTree %}
Packit 1c1d7e
      {% create namespaceTree.fileName|append:config.HTML_FILE_EXTENSION from 'htmlnamespaces.tpl' %}
Packit 1c1d7e
    {% endwith %}
Packit 1c1d7e
  {% endif %}
Packit 1c1d7e
Packit 1c1d7e
  {# write symbol indices for namespace members #}
Packit 1c1d7e
  {% if namespaceMembersIndex.all %}
Packit 1c1d7e
    {% with page=namespaceMembersIndex scope='namespace' template='htmlnsmembers.tpl' %}
Packit 1c1d7e
      {% indexentry nav name=tr.namespaceMembers file=page.fileName anchor='' isReference=False %}
Packit 1c1d7e
      {% include 'htmlmembersindex.tpl' %}
Packit 1c1d7e
    {% endwith %}
Packit 1c1d7e
  {% endif %}
Packit 1c1d7e
Packit 1c1d7e
  {% closesubindex nav %}
Packit 1c1d7e
{% endif %}
Packit 1c1d7e
Packit 1c1d7e
{# --- classes --- #}
Packit 1c1d7e
{% if classList %}
Packit 1c1d7e
  {% indexentry nav name=tr.classes file='' anchor='' isReference=False %}
Packit 1c1d7e
  {% opensubindex nav %}
Packit 1c1d7e
Packit 1c1d7e
  {# write the annotated class list #}
Packit 1c1d7e
  {% if classTree.tree %}
Packit 1c1d7e
    {% with page=classTree %}
Packit 1c1d7e
      {% create classTree.fileName|append:config.HTML_FILE_EXTENSION from 'htmlannotated.tpl' %}
Packit 1c1d7e
    {% endwith %}
Packit 1c1d7e
  {% endif %}
Packit 1c1d7e
Packit 1c1d7e
  {# write class index #}
Packit 1c1d7e
  {% if classIndex.list %}
Packit 1c1d7e
    {% with page=classIndex %}
Packit 1c1d7e
      {% create classIndex.fileName|append:config.HTML_FILE_EXTENSION from 'htmlclasses.tpl' %}
Packit 1c1d7e
    {% endwith %}
Packit 1c1d7e
  {% endif %}
Packit 1c1d7e
Packit 1c1d7e
  {# write the class inheritance hierarchy #}
Packit 1c1d7e
  {% if classHierarchy.tree %}
Packit 1c1d7e
    {% with page=classHierarchy %}
Packit 1c1d7e
      {% create classHierarchy.fileName|append:config.HTML_FILE_EXTENSION from 'htmlhierarchy.tpl' %}
Packit 1c1d7e
      {% if config.HAVE_DOT and config.GRAPHICAL_HIERARCHY %}
Packit 1c1d7e
        {% with fileName='inherits' %}
Packit 1c1d7e
          {% create fileName|append:config.HTML_FILE_EXTENSION from 'htmlgraphhierarchy.tpl' %}
Packit 1c1d7e
        {% endwith %}
Packit 1c1d7e
      {% endif %}
Packit 1c1d7e
    {% endwith %}
Packit 1c1d7e
  {% endif %}
Packit 1c1d7e
Packit 1c1d7e
  {# write symbol indices for class members #}
Packit 1c1d7e
  {% if classMembersIndex.all %}
Packit 1c1d7e
    {% with page=classMembersIndex scope='class' template='htmlclmembers.tpl' %}
Packit 1c1d7e
      {% indexentry nav name=tr.classMembers file=page.fileName anchor='' isReference=False %}
Packit 1c1d7e
      {% include 'htmlmembersindex.tpl' %}
Packit 1c1d7e
    {% endwith %}
Packit 1c1d7e
  {% endif %}
Packit 1c1d7e
Packit 1c1d7e
  {% closesubindex nav %}
Packit 1c1d7e
{% endif %}
Packit 1c1d7e
Packit 1c1d7e
{# --- files --- #}
Packit 1c1d7e
{% if fileList %}
Packit 1c1d7e
  {% indexentry nav name=tr.files file='' anchor='' isReference=False %}
Packit 1c1d7e
  {% opensubindex nav %}
Packit 1c1d7e
Packit 1c1d7e
  {# write the directory/file hierarchy #}
Packit 1c1d7e
  {% if fileTree.tree %}
Packit 1c1d7e
    {% with page=fileTree %}
Packit 1c1d7e
      {% create fileTree.fileName|append:config.HTML_FILE_EXTENSION from 'htmlfiles.tpl' %}
Packit 1c1d7e
    {% endwith %}
Packit 1c1d7e
  {% endif %}
Packit 1c1d7e
Packit 1c1d7e
  {# write symbol indices for global namespace #}
Packit 1c1d7e
  {% if globalsIndex.all %}
Packit 1c1d7e
    {% with page=globalsIndex scope='file' template='htmlflmembers.tpl' %}
Packit 1c1d7e
      {% indexentry nav name=tr.fileMembers file=page.fileName anchor='' isReference=False %}
Packit 1c1d7e
      {% include 'htmlmembersindex.tpl' %}
Packit 1c1d7e
    {% endwith %}
Packit 1c1d7e
  {% endif %}
Packit 1c1d7e
Packit 1c1d7e
  {% closesubindex nav %}
Packit 1c1d7e
{% endif %}
Packit 1c1d7e
Packit 1c1d7e
{# write directory documentation pages #}
Packit 1c1d7e
{% for compound in dirList %}
Packit 1c1d7e
  {% with page=compound %}
Packit 1c1d7e
    {% create compound.fileName|append:config.HTML_FILE_EXTENSION from 'htmldir.tpl' %}
Packit 1c1d7e
  {% endwith %}
Packit 1c1d7e
{% endfor %}
Packit 1c1d7e
Packit 1c1d7e
{# close the global navigation index #}
Packit 1c1d7e
{% closesubindex nav %}
Packit 1c1d7e
Packit 1c1d7e
{# write search data #}
Packit 1c1d7e
{% if config.SEARCHENGINE and not config.SERVER_BASED_SEARCH %}
Packit 1c1d7e
  {% create 'search/searchdata.js' from 'htmljssearchdata.tpl' %}
Packit 1c1d7e
  {% for idx in searchIndices %}
Packit 1c1d7e
    {% for si in idx.symbolIndices %}
Packit 1c1d7e
      {% with baseName=si.name|append:'_'|append:forloop.counter0 %}
Packit 1c1d7e
        {% create baseName|prepend:'search/'|append:config.HTML_FILE_EXTENSION from 'htmlsearchresult.tpl' %}
Packit 1c1d7e
        {% create baseName|prepend:'search/'|append:'.js' from 'htmljssearchindex.tpl' %}
Packit 1c1d7e
      {% endwith %}
Packit 1c1d7e
    {% endfor %}
Packit 1c1d7e
  {% endfor %}
Packit 1c1d7e
{% endif %}
Packit 1c1d7e
Packit 1c1d7e
{# write html help index #}
Packit 1c1d7e
{% if config.GENERATE_HTMLHELP %}
Packit 1c1d7e
  {% encoding config.CHM_INDEX_ENCODING|default:'CP1250' %}
Packit 1c1d7e
    {% create 'index.hhp' from 'htmlhelpindexhhp.tpl' %}
Packit 1c1d7e
    {% create 'index.hhc' from 'htmlhelpindexhhc.tpl' %}
Packit 1c1d7e
  {% endencoding %}
Packit 1c1d7e
{% endif %}
Packit 1c1d7e
Packit 1c1d7e
{# write the navigation tree data #}
Packit 1c1d7e
{% if config.GENERATE_TREEVIEW %}
Packit 1c1d7e
  {% create 'navtreedata.js' from 'htmljsnavtree.tpl' %}
Packit 1c1d7e
{% endif %}
Packit 1c1d7e
Packit 1c1d7e
{# write menu data #}
Packit 1c1d7e
{% if not config.DISABLE_INDEX %}
Packit 1c1d7e
  {% create 'menudata.js' from 'htmljsmenudata.tpl' %}
Packit 1c1d7e
{% endif %}
Packit 1c1d7e
Packit 1c1d7e
{% msg %}----- End generating HTML output for {{ config.PROJECT_NAME }} from template ----{% endmsg %}