Update Documentation
- added screenshot - added doc export using pandoc to html and pdf
This commit is contained in:
Dustin Brunner
BIN
doc/build/Documentation.pdf
vendored
Normal file
BIN
doc/build/Documentation.pdf
vendored
Normal file
Binary file not shown.
26401
doc/build/index.html
vendored
Normal file
26401
doc/build/index.html
vendored
Normal file
File diff suppressed because one or more lines are too long
123
doc/tools/bootstrap_menu.html
Normal file
123
doc/tools/bootstrap_menu.html
Normal file
@@ -0,0 +1,123 @@
|
||||
<!doctype html>
|
||||
<html $if(lang)$ lang="$lang$" $endif$>
|
||||
<head>
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="http://css3-mediaqueries-js.googlecode.com/svn/trunk/css3-mediaqueries.js"></script>
|
||||
<![endif]-->
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta http-equiv="Content-Style-Type" content="text/css" />
|
||||
|
||||
<!-- <link rel="stylesheet" type="text/css" href="template.css" /> -->
|
||||
<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/gh/diversen/pandoc-bootstrap-adaptive-template@959c3622/template.css" />
|
||||
|
||||
<link href="https://vjs.zencdn.net/5.4.4/video-js.css" rel="stylesheet" />
|
||||
|
||||
<script src="https://code.jquery.com/jquery-2.2.1.min.js"></script>
|
||||
<!-- <script type='text/javascript' src='menu/js/jquery.cookie.js'></script> -->
|
||||
<!-- <script type='text/javascript' src='menu/js/jquery.hoverIntent.minified.js'></script> -->
|
||||
<!-- <script type='text/javascript' src='menu/js/jquery.dcjqaccordion.2.7.min.js'></script> -->
|
||||
|
||||
<!-- <link href="menu/css/skins/blue.css" rel="stylesheet" type="text/css" /> -->
|
||||
<!-- <link href="menu/css/skins/graphite.css" rel="stylesheet" type="text/css" /> -->
|
||||
<!-- <link href="menu/css/skins/grey.css" rel="stylesheet" type="text/css" /> -->
|
||||
|
||||
<!-- <script src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script> -->
|
||||
|
||||
|
||||
<!-- <script src="script.js"></script> -->
|
||||
|
||||
<!-- <script src="jquery.sticky-kit.js "></script> -->
|
||||
<script type='text/javascript' src='https://cdn.jsdelivr.net/gh/diversen/pandoc-bootstrap-adaptive-template@959c3622/menu/js/jquery.cookie.js'></script>
|
||||
<script type='text/javascript' src='https://cdn.jsdelivr.net/gh/diversen/pandoc-bootstrap-adaptive-template@959c3622/menu/js/jquery.hoverIntent.minified.js'></script>
|
||||
<script type='text/javascript' src='https://cdn.jsdelivr.net/gh/diversen/pandoc-bootstrap-adaptive-template@959c3622/menu/js/jquery.dcjqaccordion.2.7.min.js'></script>
|
||||
|
||||
<link href="https://cdn.jsdelivr.net/gh/diversen/pandoc-bootstrap-adaptive-template@959c3622/menu/css/skins/blue.css" rel="stylesheet" type="text/css" />
|
||||
<link href="https://cdn.jsdelivr.net/gh/diversen/pandoc-bootstrap-adaptive-template@959c3622/menu/css/skins/graphite.css" rel="stylesheet" type="text/css" />
|
||||
<link href="https://cdn.jsdelivr.net/gh/diversen/pandoc-bootstrap-adaptive-template@959c3622/menu/css/skins/grey.css" rel="stylesheet" type="text/css" />
|
||||
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.4/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||
|
||||
<script src="https://cdn.jsdelivr.net/gh/diversen/pandoc-bootstrap-adaptive-template@959c3622/script.js"></script>
|
||||
|
||||
<script src="https://cdn.jsdelivr.net/gh/diversen/pandoc-bootstrap-adaptive-template@959c3622/jquery.sticky-kit.js"></script>
|
||||
<meta name="generator" content="pandoc" />
|
||||
$for(author-meta)$
|
||||
<meta name="author" content="$author-meta$" />
|
||||
$endfor$
|
||||
$if(date-meta)$
|
||||
<meta name="date" content="$date-meta$" />
|
||||
$endif$
|
||||
<title>$if(title-prefix)$$title-prefix$ - $endif$$pagetitle$</title>
|
||||
<style type="text/css">code{white-space: pre;}</style>
|
||||
$if(quotes)$
|
||||
<style type="text/css">q { quotes: "“" "”" "‘" "’"; }</style>
|
||||
$endif$
|
||||
$if(highlighting-css)$
|
||||
<style type="text/css">
|
||||
$highlighting-css$
|
||||
</style>
|
||||
$endif$
|
||||
$for(css)$
|
||||
<link rel="stylesheet" href="$css$" $if(html5)$$else$type="text/css" $endif$/>
|
||||
$endfor$
|
||||
$if(math)$
|
||||
$math$
|
||||
$endif$
|
||||
$for(header-includes)$
|
||||
$header-includes$
|
||||
$endfor$
|
||||
</head>
|
||||
<body>
|
||||
|
||||
|
||||
$if(title)$
|
||||
<div class="navbar navbar-static-top">
|
||||
<div class="navbar-inner">
|
||||
<div class="container">
|
||||
<span class="doc-title">$title$</span>
|
||||
<ul class="nav pull-right doc-info">
|
||||
$for(author)$
|
||||
<li><p class="navbar-text">$author$</p></li>
|
||||
$endfor$
|
||||
$if(date)$
|
||||
<li><p class="navbar-text">$date$</p></li>
|
||||
$endif$
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
$endif$
|
||||
<div class="container">
|
||||
<div class="row">
|
||||
$if(toc)$
|
||||
<div id="$idprefix$TOC" class="span3">
|
||||
<div class="well toc">
|
||||
|
||||
$toc$
|
||||
|
||||
</div>
|
||||
</div>
|
||||
$endif$
|
||||
<div class="span$if(toc)$9$else$12$endif$">
|
||||
|
||||
$if(abstract)$
|
||||
<H1>$abstract-title$</H1>
|
||||
$abstract$
|
||||
$endif$
|
||||
|
||||
$for(include-before)$
|
||||
$include-before$
|
||||
$endfor$
|
||||
$body$
|
||||
$for(include-after)$
|
||||
$include-after$
|
||||
$endfor$
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<script src="https://vjs.zencdn.net/5.4.4/video.js"></script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
1065
doc/tools/eisvogel.latex
Normal file
1065
doc/tools/eisvogel.latex
Normal file
File diff suppressed because it is too large
Load Diff
61
doc/tools/noexport-subtrees.lua
Normal file
61
doc/tools/noexport-subtrees.lua
Normal file
@@ -0,0 +1,61 @@
|
||||
--[[
|
||||
Remove all subtrees whose headlines contain class `noexport`.
|
||||
|
||||
License: MIT
|
||||
Copyright: © Albert Krewinkel
|
||||
]]
|
||||
|
||||
-- pandoc.utils.make_sections exists since pandoc 2.8
|
||||
PANDOC_VERSION:must_be_at_least {2,8}
|
||||
|
||||
local utils = require 'pandoc.utils'
|
||||
|
||||
-- Returns true iff a div is a section div.
|
||||
local function is_section_div (div)
|
||||
return div.t == 'Div'
|
||||
and div.classes[1] == 'section'
|
||||
and div.attributes.number
|
||||
end
|
||||
|
||||
-- Returns the header element of a section, or nil if the argument is not a
|
||||
-- section.
|
||||
local function section_header (div)
|
||||
if not div.t == 'Div' then return nil end
|
||||
local header = div.content and div.content[1]
|
||||
local is_header = is_section_div(div)
|
||||
and header
|
||||
and header.t == 'Header'
|
||||
return is_header and header or nil
|
||||
end
|
||||
|
||||
--- Remove remaining section divs
|
||||
local function flatten_sections (div)
|
||||
local header = section_header(div)
|
||||
if not header then
|
||||
return nil
|
||||
else
|
||||
header.identifier = div.identifier
|
||||
div.content[1] = header
|
||||
return div.content
|
||||
end
|
||||
end
|
||||
|
||||
function drop_noexport_sections (div)
|
||||
if div.classes:includes('noexport') then
|
||||
return {}
|
||||
end
|
||||
end
|
||||
|
||||
--- Setup the document for further processing by wrapping all
|
||||
--- sections in Div elements.
|
||||
function setup_document (doc)
|
||||
local sections = utils.make_sections(false, nil, doc.blocks)
|
||||
return pandoc.Pandoc(sections, doc.meta)
|
||||
end
|
||||
|
||||
return {
|
||||
{Pandoc = setup_document},
|
||||
{Div = drop_noexport_sections},
|
||||
{Div = flatten_sections}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user