Deploying to gh-pages from @ TREX-CoE/trexio@0027e9cb74 🚀
10
README.html
@ -3,7 +3,7 @@
|
|||||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
||||||
<head>
|
<head>
|
||||||
<!-- 2021-09-24 Fri 08:06 -->
|
<!-- 2021-09-24 Fri 10:10 -->
|
||||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||||
<title>TREXIO source code documentation</title>
|
<title>TREXIO source code documentation</title>
|
||||||
@ -180,6 +180,12 @@
|
|||||||
.org-svg { width: 90%; }
|
.org-svg { width: 90%; }
|
||||||
/*]]>*/-->
|
/*]]>*/-->
|
||||||
</style>
|
</style>
|
||||||
|
<link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/css/htmlize.css"/>
|
||||||
|
<link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/css/readtheorg.css"/>
|
||||||
|
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
|
||||||
|
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
|
||||||
|
<script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/lib/js/jquery.stickytableheaders.min.js"></script>
|
||||||
|
<script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/js/readtheorg.js"></script>
|
||||||
<link rel="stylesheet" title="Standard" href="trexio.css" type="text/css" />
|
<link rel="stylesheet" title="Standard" href="trexio.css" type="text/css" />
|
||||||
|
|
||||||
<script type="text/javascript" src="org-info.js">
|
<script type="text/javascript" src="org-info.js">
|
||||||
@ -343,7 +349,7 @@ and bug reports should be submitted at
|
|||||||
</div>
|
</div>
|
||||||
<div id="postamble" class="status">
|
<div id="postamble" class="status">
|
||||||
<p class="author">Author: TREX-CoE</p>
|
<p class="author">Author: TREX-CoE</p>
|
||||||
<p class="date">Created: 2021-09-24 Fri 08:06</p>
|
<p class="date">Created: 2021-09-24 Fri 10:10</p>
|
||||||
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
||||||
</div>
|
</div>
|
||||||
</body>
|
</body>
|
||||||
|
16
Sparse.html
@ -3,7 +3,7 @@
|
|||||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
||||||
<head>
|
<head>
|
||||||
<!-- 2021-09-24 Fri 08:06 -->
|
<!-- 2021-09-24 Fri 10:10 -->
|
||||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||||
<title>‎</title>
|
<title>‎</title>
|
||||||
@ -232,8 +232,8 @@ for the JavaScript code in this tag.
|
|||||||
<h2>Table of Contents</h2>
|
<h2>Table of Contents</h2>
|
||||||
<div id="text-table-of-contents">
|
<div id="text-table-of-contents">
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org190d2f4">1. Text back end</a></li>
|
<li><a href="#orgf7553d5">1. Text back end</a></li>
|
||||||
<li><a href="#org65925d6">2. HDF5 Back end</a></li>
|
<li><a href="#org7400b18">2. HDF5 Back end</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
@ -241,8 +241,8 @@ for the JavaScript code in this tag.
|
|||||||
See templator<sub>front.org</sub>
|
See templator<sub>front.org</sub>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<div id="outline-container-org190d2f4" class="outline-2">
|
<div id="outline-container-orgf7553d5" class="outline-2">
|
||||||
<h2 id="org190d2f4"><span class="section-number-2">1</span> Text back end</h2>
|
<h2 id="orgf7553d5"><span class="section-number-2">1</span> Text back end</h2>
|
||||||
<div class="outline-text-2" id="text-1">
|
<div class="outline-text-2" id="text-1">
|
||||||
<p>
|
<p>
|
||||||
As the size of the dataset should be extensible, the simplest
|
As the size of the dataset should be extensible, the simplest
|
||||||
@ -256,8 +256,8 @@ The offset can be used with <code>fseek(69L*offset, SEEK_SET)</code>
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org65925d6" class="outline-2">
|
<div id="outline-container-org7400b18" class="outline-2">
|
||||||
<h2 id="org65925d6"><span class="section-number-2">2</span> HDF5 Back end</h2>
|
<h2 id="org7400b18"><span class="section-number-2">2</span> HDF5 Back end</h2>
|
||||||
<div class="outline-text-2" id="text-2">
|
<div class="outline-text-2" id="text-2">
|
||||||
<p>
|
<p>
|
||||||
We need to declare the number of rows of the dataset as
|
We need to declare the number of rows of the dataset as
|
||||||
@ -278,7 +278,7 @@ If the offset+num > nmax, we need to extend the dataset.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div id="postamble" class="status">
|
<div id="postamble" class="status">
|
||||||
<p class="date">Created: 2021-09-24 Fri 08:06</p>
|
<p class="date">Created: 2021-09-24 Fri 10:10</p>
|
||||||
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
||||||
</div>
|
</div>
|
||||||
</body>
|
</body>
|
||||||
|
10
index.html
@ -3,7 +3,7 @@
|
|||||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
||||||
<head>
|
<head>
|
||||||
<!-- 2021-09-24 Fri 08:06 -->
|
<!-- 2021-09-24 Fri 10:10 -->
|
||||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||||
<title>TREXIO source code documentation</title>
|
<title>TREXIO source code documentation</title>
|
||||||
@ -180,6 +180,12 @@
|
|||||||
.org-svg { width: 90%; }
|
.org-svg { width: 90%; }
|
||||||
/*]]>*/-->
|
/*]]>*/-->
|
||||||
</style>
|
</style>
|
||||||
|
<link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/css/htmlize.css"/>
|
||||||
|
<link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/css/readtheorg.css"/>
|
||||||
|
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
|
||||||
|
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
|
||||||
|
<script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/lib/js/jquery.stickytableheaders.min.js"></script>
|
||||||
|
<script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/js/readtheorg.js"></script>
|
||||||
<link rel="stylesheet" title="Standard" href="trexio.css" type="text/css" />
|
<link rel="stylesheet" title="Standard" href="trexio.css" type="text/css" />
|
||||||
|
|
||||||
<script type="text/javascript" src="org-info.js">
|
<script type="text/javascript" src="org-info.js">
|
||||||
@ -343,7 +349,7 @@ and bug reports should be submitted at
|
|||||||
</div>
|
</div>
|
||||||
<div id="postamble" class="status">
|
<div id="postamble" class="status">
|
||||||
<p class="author">Author: TREX-CoE</p>
|
<p class="author">Author: TREX-CoE</p>
|
||||||
<p class="date">Created: 2021-09-24 Fri 08:06</p>
|
<p class="date">Created: 2021-09-24 Fri 10:10</p>
|
||||||
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
||||||
</div>
|
</div>
|
||||||
</body>
|
</body>
|
||||||
|
5
org-html-themes/.gitignore
vendored
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
org/theme-bigblow-local-abs.setup
|
||||||
|
org/theme-readtheorg-local-abs.setup
|
||||||
|
demo/mbacou.org
|
||||||
|
demo/cdominik-muziek2.org
|
||||||
|
demo/dev.org
|
674
org-html-themes/LICENSE
Normal file
@ -0,0 +1,674 @@
|
|||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
Org-HTML-Themes
|
||||||
|
Copyright (C) 2014-2020 Fabrice Niessen
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
Org-HTML-Themes Copyright (C) 2014-2020 Fabrice Niessen
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
266
org-html-themes/README.org
Normal file
@ -0,0 +1,266 @@
|
|||||||
|
#+TITLE: How to export Org mode files into awesome HTML in 2 minutes
|
||||||
|
#+AUTHOR: Fabrice Niessen
|
||||||
|
#+EMAIL: (concat "fniessen" at-sign "pirilampo.org")
|
||||||
|
#+DESCRIPTION: Org-HTML export made simple.
|
||||||
|
#+KEYWORDS: org-mode, export, html, theme, style, css, js, bigblow
|
||||||
|
#+LANGUAGE: en
|
||||||
|
#+OPTIONS: H:4 toc:t num:2
|
||||||
|
|
||||||
|
#+PROPERTY: header-args :padline no
|
||||||
|
#+SETUPFILE: ~/org/theme-readtheorg.setup
|
||||||
|
|
||||||
|
#+html: <a href="http://opensource.org/licenses/GPL-3.0">
|
||||||
|
#+html: <img src="http://img.shields.io/:license-gpl-blue.svg" alt=":license-gpl-blue.svg" />
|
||||||
|
#+html: </a>
|
||||||
|
#+html: <a href="https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=VCVAS6KPDQ4JC&lc=BE&item_number=org%2dhtml%2dthemes¤cy_code=EUR&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted">
|
||||||
|
#+html: <img src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" alt="btn_donate_LG.gif" />
|
||||||
|
#+html: </a>
|
||||||
|
|
||||||
|
* Overview
|
||||||
|
|
||||||
|
** Description
|
||||||
|
|
||||||
|
Though you can easily override CSS stylesheets and add your own HTML themes, we
|
||||||
|
can say (or write) that Org mode provides a /basic/ HTML support.
|
||||||
|
|
||||||
|
*Org-HMTL themes* is an open source framework for providing you with a list of
|
||||||
|
very nice (cross-browser) themes for all your Org documents. Use them to *style
|
||||||
|
your docs*, and your colleagues will come up to tell you that you are a genius!
|
||||||
|
|
||||||
|
Share this content by tweeting this page:
|
||||||
|
|
||||||
|
#+html: <script src="http://platform.twitter.com/widgets.js"></script>
|
||||||
|
#+html: <a href="https://twitter.com/share" class="twitter-share-button" data-via="f_niessen">Tweet</a>
|
||||||
|
|
||||||
|
Follow [[https://twitter.com/f_niessen][f_niessen]] on Twitter for updates on Org-HTML themes!
|
||||||
|
|
||||||
|
** Requirements
|
||||||
|
|
||||||
|
Org mode version 8 (or later) is required.
|
||||||
|
|
||||||
|
If such a version is not bundled with your Emacs, install one from ELPA.
|
||||||
|
|
||||||
|
* Gallery
|
||||||
|
:PROPERTIES:
|
||||||
|
:ID: 79e0ed21-c3b0-4f00-bdab-29fbff9dcad4
|
||||||
|
:END:
|
||||||
|
|
||||||
|
This is a list of available *HTML themes for Org mode*, which you can use right
|
||||||
|
now! Well, I hope to have more than one in a couple of weeks...
|
||||||
|
|
||||||
|
** Bigblow
|
||||||
|
|
||||||
|
Bigblow is perfect for your work: it is a clean design aimed at optimal *Org
|
||||||
|
mode experience in your browser*. It looks just awesome!
|
||||||
|
|
||||||
|
#+ATTR_HTML: :width 640
|
||||||
|
[[https://www.youtube.com/watch?v=DnSGSiXYuOk][file:docs/bigblow.png]]
|
||||||
|
|
||||||
|
Click on the image for a quick [[https://www.youtube.com/watch?v=DnSGSiXYuOk][demo of Bigblow]] (2:49 min, no audio).
|
||||||
|
|
||||||
|
Keyboard shortcuts to save time and boost your productivity:
|
||||||
|
|
||||||
|
| Shortcut | What it does |
|
||||||
|
|----------+-----------------------------------|
|
||||||
|
| =?= or =h= | Access the *dashboard* |
|
||||||
|
| =n= | Move to the *next* main heading |
|
||||||
|
| =p= | Move to the *previous* main heading |
|
||||||
|
| =b= | Scroll up |
|
||||||
|
| =<= | Scroll to top |
|
||||||
|
| =>= | Scroll to bottom |
|
||||||
|
| =-= | Collapse all |
|
||||||
|
| =+= | Expand all |
|
||||||
|
| =r= | Go to next task in list |
|
||||||
|
| =R= | Go to previous task in list |
|
||||||
|
| =q= | Stop reviewing the list of tasks |
|
||||||
|
| =g= | Reload the page |
|
||||||
|
|
||||||
|
*** Quotations about Bigblow
|
||||||
|
|
||||||
|
"Very very nice, I enjoy it a lot." \\
|
||||||
|
-- /Ista Zahn/
|
||||||
|
|
||||||
|
"This is awesome. I love it!" \\
|
||||||
|
-- /Rainer M Krug/
|
||||||
|
|
||||||
|
"This is awesome!!" \\
|
||||||
|
-- /Mehul Sanghvi/
|
||||||
|
|
||||||
|
"This very nice html theme. [...] I cannot use another emacs-theme than your
|
||||||
|
[[https://github.com/fniessen/emacs-leuven-theme][emacs-leuven-theme]], and it is going to be probably the same with your html
|
||||||
|
theme!" \\
|
||||||
|
-- /Joseph Vidal-Rosset/
|
||||||
|
|
||||||
|
"Thanks a lot for sharing [...] the wonderful Bigblow theme. I create lot of
|
||||||
|
specification for other team members to use. It has always been a trouble to
|
||||||
|
share and maintain such spec. Now, I can create a much neater spec which is
|
||||||
|
available for the team's reference as a webpage." \\
|
||||||
|
-- /Shankar R./
|
||||||
|
|
||||||
|
"I like Bigblow the best. I've exported most of my Org files using this theme
|
||||||
|
and published them within my company's intranet. Thanks for sharing this
|
||||||
|
wonderful package!" \\
|
||||||
|
-- /Richard K./
|
||||||
|
|
||||||
|
** ReadTheOrg
|
||||||
|
|
||||||
|
ReadTheOrg is a clone of the official -- and great! -- [[https://github.com/snide/sphinx_rtd_theme][Sphinx theme]] used in the
|
||||||
|
[[http://docs.readthedocs.org/en/latest/][Read The Docs]] site. It gives a beautiful and professional style to all your Org
|
||||||
|
docs.
|
||||||
|
|
||||||
|
*Thanks to its creator(s)!*
|
||||||
|
|
||||||
|
#+ATTR_HTML: :width 640
|
||||||
|
[[file:docs/readtheorg.png]]
|
||||||
|
|
||||||
|
#+begin_note
|
||||||
|
While the original theme shines on mobile devices as well, ReadTheOrg does not
|
||||||
|
stay completely functional.
|
||||||
|
|
||||||
|
I don't have a lot of time to maintain this project due to other
|
||||||
|
responsibilities. Help is welcome to work on that (and eventually improve the
|
||||||
|
default structure of the HTML export)!
|
||||||
|
#+end_note
|
||||||
|
|
||||||
|
*** Quotations about ReadTheOrg
|
||||||
|
|
||||||
|
"OMG. The ReadTheOrg theme for exported HTML from org mode files is eye
|
||||||
|
wateringly beautiful. Thank you!" \\
|
||||||
|
-- /Rob Stewart/
|
||||||
|
|
||||||
|
"It is fantastic, so beautiful. I will switch several of my pages over to
|
||||||
|
this theme." \\
|
||||||
|
-- /Carsten D./
|
||||||
|
|
||||||
|
"That is incredibly impressive. Thanks for this." \\
|
||||||
|
-- /Noah R./
|
||||||
|
|
||||||
|
"Thank you! I enjoy your themes. The best ones I've ever found." \\
|
||||||
|
-- /Kang T./
|
||||||
|
|
||||||
|
"Awesome theme. Wonderful job. You're doing a wonderful thing --- it will
|
||||||
|
enable people (at least those who use Emacs and Org mode) to put together
|
||||||
|
on-line reference works in a much-more usable fashion than is currently
|
||||||
|
available." \\
|
||||||
|
-- /D. C. Toedt/
|
||||||
|
|
||||||
|
"Extremely useful." \\
|
||||||
|
-- /Thomas S. Dye/
|
||||||
|
|
||||||
|
"This is amazing, I've been looking for something like this for a LONG time!
|
||||||
|
I will share." \\
|
||||||
|
-- /Edward H./
|
||||||
|
|
||||||
|
* Demo
|
||||||
|
|
||||||
|
I've written a [[file:tests/org-mode-syntax-example.org][demo page]] for the themes that provides a maximal working support
|
||||||
|
of Org mode syntax.
|
||||||
|
|
||||||
|
Please see the [[https://github.com/fniessen/refcard-org-mode][Org mode refcard]] page for full examples of headings, code,
|
||||||
|
admonitions, footnotes, tables and other details.
|
||||||
|
|
||||||
|
* Using a theme
|
||||||
|
|
||||||
|
Using a theme from the [[id:79e0ed21-c3b0-4f00-bdab-29fbff9dcad4][theme gallery]] for your own Org documents is very easy:
|
||||||
|
|
||||||
|
1. You *add a* =#+SETUPFILE:= *directive* in the preamble of your document (to include
|
||||||
|
the necessary CSS and JavaScript files).
|
||||||
|
|
||||||
|
You can either use an URL of the following type for the "setup file" of your
|
||||||
|
chosen theme:
|
||||||
|
|
||||||
|
#+begin_src org :exports code
|
||||||
|
,#+SETUPFILE: https://fniessen.github.io/org-html-themes/org/theme-NAME.setup
|
||||||
|
#+end_src
|
||||||
|
|
||||||
|
(where ~NAME~ is either ~bigblow~ or ~readtheorg~)
|
||||||
|
|
||||||
|
or, if you *cloned or downloaded* the Org-HTML themes project -- to get no
|
||||||
|
dependency on an Internet connection --, use a (relative or absolute) path to
|
||||||
|
the /local/ "setup file" and copy the =src= folder from the cloned folder
|
||||||
|
into the same folder as the file you want to export:
|
||||||
|
|
||||||
|
#+begin_src org :exports code
|
||||||
|
,#+SETUPFILE: PATH/TO/GIT/REPO/org/theme-NAME-local.setup
|
||||||
|
#+end_src
|
||||||
|
|
||||||
|
2. Then, you *export* your Org mode file *to HTML* with =org-html-export-to-html= or
|
||||||
|
with =C-c C-e h h=.
|
||||||
|
|
||||||
|
* Customizing a theme
|
||||||
|
|
||||||
|
You love those themes, but you still would like to override particular HTML
|
||||||
|
tags? Some examples do follow...
|
||||||
|
|
||||||
|
Before doing that, though, if you think it really is an improvement that could
|
||||||
|
server other persons as well, including me, you're invited to submit your
|
||||||
|
change...
|
||||||
|
|
||||||
|
** Change the background code blocks
|
||||||
|
|
||||||
|
Here's an example to insert into your Org documents:
|
||||||
|
|
||||||
|
#+begin_src org :tangle no
|
||||||
|
# Change the background of source block.
|
||||||
|
,#+HTML_HEAD: <style>pre.src{background:#343131;color:white;} </style>
|
||||||
|
#+end_src
|
||||||
|
|
||||||
|
** Unset body width limit of ReadTheOrg
|
||||||
|
|
||||||
|
Solution provided by Malcolm Cook:
|
||||||
|
|
||||||
|
#+begin_src org :tangle no
|
||||||
|
,#+HTML_HEAD: <style> #content{max-width:1800px;}</style>
|
||||||
|
,#+HTML_HEAD: <style> p{max-width:800px;}</style>
|
||||||
|
,#+HTML_HEAD: <style> li{max-width:800px;}</style
|
||||||
|
#+end_src
|
||||||
|
|
||||||
|
* Contributing
|
||||||
|
|
||||||
|
** Issues
|
||||||
|
|
||||||
|
Report issues and suggest features and improvements on the [[https://github.com/fniessen/org-html-themes/issues/new][GitHub issue tracker]].
|
||||||
|
|
||||||
|
** Patches
|
||||||
|
|
||||||
|
I love contributions! Patches under any form are always welcome!
|
||||||
|
|
||||||
|
** Donations
|
||||||
|
|
||||||
|
If you use the org-html-themes project (or any of [[https://github.com/fniessen/][my other projects]]) and feel it
|
||||||
|
is making your life better and easier, you can show your appreciation and help
|
||||||
|
support future development by making today a [[https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=VCVAS6KPDQ4JC&lc=BE&item_number=org%2dhtml%2dthemes¤cy_code=EUR&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted][donation]] through PayPal. Thank
|
||||||
|
you!
|
||||||
|
|
||||||
|
Regardless of the donations, org-html-themes will always be free both as in
|
||||||
|
beer and as in speech.
|
||||||
|
|
||||||
|
** Follow me
|
||||||
|
|
||||||
|
I have an [[https://twitter.com/f_niessen][f_niessen]] account on Twitter. You should follow it.
|
||||||
|
|
||||||
|
* License
|
||||||
|
|
||||||
|
Copyright (C) 2011-2021 Fabrice Niessen.
|
||||||
|
|
||||||
|
Author: Fabrice Niessen \\
|
||||||
|
Keywords: org-mode html themes
|
||||||
|
|
||||||
|
This program is free software; you can redistribute it and/or modify it under
|
||||||
|
the terms of the GNU General Public License as published by the Free Software
|
||||||
|
Foundation, either version 3 of the License, or (at your option) any later
|
||||||
|
version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful, but WITHOUT ANY
|
||||||
|
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
|
||||||
|
A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License along with
|
||||||
|
this program. If not, see http://www.gnu.org/licenses/.
|
||||||
|
|
||||||
|
#+html: <a href="http://opensource.org/licenses/GPL-3.0">
|
||||||
|
#+html: <img src="http://img.shields.io/:license-gpl-blue.svg" alt=":license-gpl-blue.svg" />
|
||||||
|
#+html: </a>
|
||||||
|
#+html: <a href="https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=VCVAS6KPDQ4JC&lc=BE&item_number=org%2dhtml%2dthemes¤cy_code=EUR&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted">
|
||||||
|
#+html: <img src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" alt="btn_donate_LG.gif" />
|
||||||
|
#+html: </a>
|
1
org-html-themes/_config.yml
Normal file
@ -0,0 +1 @@
|
|||||||
|
theme: jekyll-theme-minimal
|
BIN
org-html-themes/docs/bigblow.png
Normal file
After Width: | Height: | Size: 257 KiB |
BIN
org-html-themes/docs/readtheorg.png
Normal file
After Width: | Height: | Size: 48 KiB |
15
org-html-themes/org/theme-bigblow-local.setup
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
# -*- mode: org; -*-
|
||||||
|
|
||||||
|
#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="src/bigblow_theme/css/htmlize.css"/>
|
||||||
|
#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="src/bigblow_theme/css/bigblow.css"/>
|
||||||
|
#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="src/bigblow_theme/css/hideshow.css"/>
|
||||||
|
|
||||||
|
#+HTML_HEAD: <script type="text/javascript" src="src/bigblow_theme/js/jquery-1.11.0.min.js"></script>
|
||||||
|
#+HTML_HEAD: <script type="text/javascript" src="src/bigblow_theme/js/jquery-ui-1.10.2.min.js"></script>
|
||||||
|
|
||||||
|
#+HTML_HEAD: <script type="text/javascript" src="src/bigblow_theme/js/jquery.localscroll-min.js"></script>
|
||||||
|
#+HTML_HEAD: <script type="text/javascript" src="src/bigblow_theme/js/jquery.scrollTo-1.4.3.1-min.js"></script>
|
||||||
|
#+HTML_HEAD: <script type="text/javascript" src="src/bigblow_theme/js/jquery.zclip.min.js"></script>
|
||||||
|
#+HTML_HEAD: <script type="text/javascript" src="src/bigblow_theme/js/bigblow.js"></script>
|
||||||
|
#+HTML_HEAD: <script type="text/javascript" src="src/bigblow_theme/js/hideshow.js"></script>
|
||||||
|
#+HTML_HEAD: <script type="text/javascript" src="src/lib/js/jquery.stickytableheaders.min.js"></script>
|
15
org-html-themes/org/theme-bigblow.setup
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
# -*- mode: org; -*-
|
||||||
|
|
||||||
|
#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/src/bigblow_theme/css/htmlize.css"/>
|
||||||
|
#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/src/bigblow_theme/css/bigblow.css"/>
|
||||||
|
#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/src/bigblow_theme/css/hideshow.css"/>
|
||||||
|
|
||||||
|
#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/bigblow_theme/js/jquery-1.11.0.min.js"></script>
|
||||||
|
#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/bigblow_theme/js/jquery-ui-1.10.2.min.js"></script>
|
||||||
|
|
||||||
|
#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/bigblow_theme/js/jquery.localscroll-min.js"></script>
|
||||||
|
#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/bigblow_theme/js/jquery.scrollTo-1.4.3.1-min.js"></script>
|
||||||
|
#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/bigblow_theme/js/jquery.zclip.min.js"></script>
|
||||||
|
#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/bigblow_theme/js/bigblow.js"></script>
|
||||||
|
#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/bigblow_theme/js/hideshow.js"></script>
|
||||||
|
#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/lib/js/jquery.stickytableheaders.min.js"></script>
|
9
org-html-themes/org/theme-readtheorg-local.setup
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# -*- mode: org; -*-
|
||||||
|
|
||||||
|
#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="src/readtheorg_theme/css/htmlize.css"/>
|
||||||
|
#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="src/readtheorg_theme/css/readtheorg.css"/>
|
||||||
|
|
||||||
|
#+HTML_HEAD: <script type="text/javascript" src="src/lib/js/jquery.min.js"></script>
|
||||||
|
#+HTML_HEAD: <script type="text/javascript" src="src/lib/js/bootstrap.min.js"></script>
|
||||||
|
#+HTML_HEAD: <script type="text/javascript" src="src/lib/js/jquery.stickytableheaders.min.js"></script>
|
||||||
|
#+HTML_HEAD: <script type="text/javascript" src="src/readtheorg_theme/js/readtheorg.js"></script>
|
9
org-html-themes/org/theme-readtheorg.setup
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# -*- mode: org; -*-
|
||||||
|
|
||||||
|
#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/css/htmlize.css"/>
|
||||||
|
#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/css/readtheorg.css"/>
|
||||||
|
|
||||||
|
#+HTML_HEAD: <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
|
||||||
|
#+HTML_HEAD: <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
|
||||||
|
#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/lib/js/jquery.stickytableheaders.min.js"></script>
|
||||||
|
#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/js/readtheorg.js"></script>
|
756
org-html-themes/src/bigblow_theme/css/bigblow.css
Normal file
@ -0,0 +1,756 @@
|
|||||||
|
/* bigblow.css --- BigBlow CSS file */
|
||||||
|
|
||||||
|
/* Copyright (C) 2011-2014 All Right Reserved, Fabrice Niessen */
|
||||||
|
|
||||||
|
/* This file is free software: you can redistribute it and/or */
|
||||||
|
/* modify it under the terms of the GNU General Public License as */
|
||||||
|
/* published by the Free Software Foundation, either version 3 of */
|
||||||
|
/* the License, or (at your option) any later version. */
|
||||||
|
|
||||||
|
/* This file is distributed in the hope that it will be useful, */
|
||||||
|
/* but WITHOUT ANY WARRANTY; without even the implied warranty of */
|
||||||
|
/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
|
||||||
|
/* GNU General Public License for more details. */
|
||||||
|
|
||||||
|
/* Author: Fabrice Niessen <(concat "fniessen" at-sign "pirilampo.org")> */
|
||||||
|
/* URL: https://github.com/fniessen/org-html-themes/ */
|
||||||
|
/* Version: 20140605.0925 */
|
||||||
|
|
||||||
|
html, body {
|
||||||
|
border: 0;
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media print {
|
||||||
|
.dontprint {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#preamble {
|
||||||
|
background: none repeat scroll 0 0 #46484B;
|
||||||
|
color: #FFFFFF;
|
||||||
|
font-family: Arial,Helvetica,sans-serif;
|
||||||
|
font-size: 70%;
|
||||||
|
font-weight: bold;
|
||||||
|
height: 224px; /* so that content begins after... */
|
||||||
|
padding: 2px 2px 0 6px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#banner {
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
#tabs {
|
||||||
|
background-color: #2061A2;
|
||||||
|
float: left;
|
||||||
|
margin: 0px 0px 20px 0px;
|
||||||
|
padding: 0;
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
#tabs ul {
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
#tabs li {
|
||||||
|
float: left;
|
||||||
|
list-style-type: none;
|
||||||
|
margin: 0px 2px 0px 0px;
|
||||||
|
padding: 0px 0px 0px 0px;
|
||||||
|
white-space: nowrap;
|
||||||
|
}
|
||||||
|
|
||||||
|
#tabs li a {
|
||||||
|
color: #EEEEEE;
|
||||||
|
display: block;
|
||||||
|
font-size: 13px;
|
||||||
|
font-weight: bold;
|
||||||
|
margin: 0;
|
||||||
|
padding: 4px 10px 4px 10px;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
#tabs li a:hover {
|
||||||
|
background: #759FCF;
|
||||||
|
color: #FFFFFF;
|
||||||
|
}
|
||||||
|
|
||||||
|
#tabs li.ui-tabs-active a {
|
||||||
|
background: #FFFFFF;
|
||||||
|
color: #555555;
|
||||||
|
}
|
||||||
|
|
||||||
|
#content {
|
||||||
|
clear: both;
|
||||||
|
background-color: #FFFFFF;
|
||||||
|
font-size: 100%;
|
||||||
|
margin: 0 auto;
|
||||||
|
max-width: 810px;
|
||||||
|
overflow-x: hidden;
|
||||||
|
overflow-y: auto;
|
||||||
|
padding: 0px 10px 2px 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#postamble {
|
||||||
|
color: #999999;
|
||||||
|
font-family: Arial,Helvetica,sans-serif;
|
||||||
|
font-size: 70%;
|
||||||
|
height: 40px;
|
||||||
|
margin: 0 auto;
|
||||||
|
max-width: 810px;
|
||||||
|
padding-right: 30px;
|
||||||
|
padding-top: 22px;
|
||||||
|
padding: 2px 2px 0 6px;
|
||||||
|
text-align: right;
|
||||||
|
}
|
||||||
|
|
||||||
|
body {
|
||||||
|
color: #333333;
|
||||||
|
font: 13px/1.385 arial,helvetica,clean,sans-serif;
|
||||||
|
margin: 0 .1em;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
b {
|
||||||
|
color: #000000;
|
||||||
|
}
|
||||||
|
|
||||||
|
i {
|
||||||
|
color: #1A1A1A;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1, ul#tabs, h2, h3, h4, h5 {
|
||||||
|
font-family: "Trebuchet MS",Verdana,sans-serif;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1 {
|
||||||
|
background-color: #0A3F69;
|
||||||
|
color: #F8F8F8;
|
||||||
|
font-size: 24px;
|
||||||
|
margin: 0;
|
||||||
|
padding: 9px 0px 0px 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
h2 {
|
||||||
|
border-bottom: 4px solid #67B3E3;
|
||||||
|
color: #13679D;
|
||||||
|
font-size: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
h3, h4, h5, h6 {
|
||||||
|
color: #1572AE;
|
||||||
|
}
|
||||||
|
|
||||||
|
h3 {
|
||||||
|
border-bottom: 1px solid #B5DAF1;
|
||||||
|
font-size: 16px;
|
||||||
|
margin-left: 25px;
|
||||||
|
}
|
||||||
|
|
||||||
|
h4 {
|
||||||
|
border-bottom: 1px dotted #C9E3F5;
|
||||||
|
font-size: 14px;
|
||||||
|
margin-left: 60px;
|
||||||
|
}
|
||||||
|
|
||||||
|
h5 {
|
||||||
|
font-size: 1em;
|
||||||
|
margin-left: 87px;
|
||||||
|
}
|
||||||
|
|
||||||
|
h6 {
|
||||||
|
font-size: 1em;
|
||||||
|
margin-left: 100px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.DONEheader {
|
||||||
|
color: #ADADAD;
|
||||||
|
text-decoration: line-through;
|
||||||
|
}
|
||||||
|
|
||||||
|
h3.DONEheader {
|
||||||
|
border-bottom: 1px solid #DDDDDD;
|
||||||
|
}
|
||||||
|
|
||||||
|
h4.DONEheader {
|
||||||
|
border-bottom: 1px dotted #DDDDDD;
|
||||||
|
}
|
||||||
|
|
||||||
|
.outline-text-2, .outline-text-3, .outline-text-4, .outline-text-5,
|
||||||
|
.outline-3 > ul, /* for HTML export of Beamer slides */
|
||||||
|
.outline-4 > ol, #text-footnotes {
|
||||||
|
margin-left: 100px;
|
||||||
|
}
|
||||||
|
|
||||||
|
li > .outline-text-5 {
|
||||||
|
margin-left: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
ul, ol {
|
||||||
|
padding-left: 1.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
dt {
|
||||||
|
color: #1572AE;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
dd {
|
||||||
|
margin-bottom: 6px;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre {
|
||||||
|
/* Use #EAEAEA for background-color of border with src code block's name */
|
||||||
|
background-color: #F8F8FF;
|
||||||
|
border: 1px solid #DEDEDE;
|
||||||
|
color: #444444;
|
||||||
|
font-family: monospace;
|
||||||
|
line-height: 1.14em;
|
||||||
|
overflow: auto;
|
||||||
|
/* overflow-x: auto; */
|
||||||
|
padding: 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
code {
|
||||||
|
background-color: #F8F8FF;
|
||||||
|
border: 1px solid #DEDEDE;
|
||||||
|
color: #444444;
|
||||||
|
font-family: monospace;
|
||||||
|
/* font-size: 0.93em; */
|
||||||
|
margin: 0px 1px;
|
||||||
|
padding: 0px 2px;
|
||||||
|
}
|
||||||
|
|
||||||
|
li > p, li > ul, li > .inlinetask, li > dl {
|
||||||
|
margin-left: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
dd > p, dd > ul, dd > .inlinetask, dd > dl {
|
||||||
|
margin-left: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
li.checked {
|
||||||
|
list-style-image: url('../images/checked.png');
|
||||||
|
}
|
||||||
|
|
||||||
|
li.halfchecked {
|
||||||
|
list-style-image: url('../images/halfchecked.png');
|
||||||
|
}
|
||||||
|
|
||||||
|
li.unchecked {
|
||||||
|
list-style-image: url('../images/unchecked.png');
|
||||||
|
}
|
||||||
|
|
||||||
|
a, a:link, a:visited {
|
||||||
|
color: #2061A2;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
a:hover {
|
||||||
|
text-decoration: underline;
|
||||||
|
}
|
||||||
|
|
||||||
|
a:focus {
|
||||||
|
outline: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
#search {
|
||||||
|
border-radius: 3px;
|
||||||
|
background: none repeat scroll 0 0 #FFFFFF;
|
||||||
|
display: block;
|
||||||
|
float: right;
|
||||||
|
height: 18px;
|
||||||
|
margin: 5px 10px 0 0;
|
||||||
|
overflow: hidden;
|
||||||
|
padding: 0 3px;
|
||||||
|
width: 188px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#search input {
|
||||||
|
border: 0 none;
|
||||||
|
color: #666666;
|
||||||
|
float: left;
|
||||||
|
font-family: Arial,Helvetica,sans-serif;
|
||||||
|
font-size: 11px;
|
||||||
|
font-weight: normal;
|
||||||
|
margin: 0;
|
||||||
|
padding: 2px 4px;
|
||||||
|
width: 160px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#search button {
|
||||||
|
background: url("../images/search-glass.png") no-repeat scroll 0 50% transparent;
|
||||||
|
border: 0 none;
|
||||||
|
cursor: pointer;
|
||||||
|
display: block;
|
||||||
|
float: right;
|
||||||
|
height: 18px;
|
||||||
|
margin: 0;
|
||||||
|
text-indent: -999em;
|
||||||
|
width: 14px;
|
||||||
|
}
|
||||||
|
|
||||||
|
table {
|
||||||
|
border-collapse: collapse;
|
||||||
|
margin-right: auto;
|
||||||
|
margin-left: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
table td {
|
||||||
|
padding: 3px 5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
table, th, td
|
||||||
|
{
|
||||||
|
border: 1px solid #B5DAF1;
|
||||||
|
border-left: 2px solid white;
|
||||||
|
border-right: 2px solid white;
|
||||||
|
}
|
||||||
|
|
||||||
|
th
|
||||||
|
{
|
||||||
|
border-width: 1px 2px;
|
||||||
|
border-color: white;
|
||||||
|
background-color: #2061A2;
|
||||||
|
color: white;
|
||||||
|
}
|
||||||
|
|
||||||
|
caption {
|
||||||
|
color: #8D8D84;
|
||||||
|
}
|
||||||
|
|
||||||
|
img {
|
||||||
|
display: block;
|
||||||
|
margin-left: auto;
|
||||||
|
margin-right: auto;
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
.figure {
|
||||||
|
color: #8D8D84;
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
.fixme {
|
||||||
|
background: #FFFF88 url('../images/fixme.png') no-repeat top left;
|
||||||
|
color: #CC0000;
|
||||||
|
display: inline-block;
|
||||||
|
height: 16px;
|
||||||
|
text-indent: -9999px;
|
||||||
|
width: 82px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.left {
|
||||||
|
text-align: left;
|
||||||
|
}
|
||||||
|
|
||||||
|
.right {
|
||||||
|
text-align: right;
|
||||||
|
}
|
||||||
|
|
||||||
|
.center {
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
.justify {
|
||||||
|
text-align: justify;
|
||||||
|
}
|
||||||
|
|
||||||
|
.inlinetask {
|
||||||
|
background-color: #F7F7F7;
|
||||||
|
border-collapse: separate;
|
||||||
|
border-color: #EEEEEE #EEEEEE #EEEEEE #1E90FF;
|
||||||
|
border-style: solid;
|
||||||
|
border-width: 1px 1px 1px 6px;
|
||||||
|
padding: 8px 8px 0px 8px;
|
||||||
|
margin: 10px 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.inlinetask td {
|
||||||
|
padding: 2px 5px 0px 2px;
|
||||||
|
border: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.info {
|
||||||
|
border: 1px solid;
|
||||||
|
background: url('../images/info.png') no-repeat 10px 10px #BDE5F8;
|
||||||
|
color: #00529B;
|
||||||
|
padding: 4px 10px 4px 52px;
|
||||||
|
border-top-left-radius: 5px;
|
||||||
|
border-top-right-radius: 5px;
|
||||||
|
border-bottom-right-radius: 5px;
|
||||||
|
border-bottom-left-radius: 5px;
|
||||||
|
margin: 10px 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.tip {
|
||||||
|
border: 1px solid;
|
||||||
|
background: url('../images/tip.png') no-repeat 10px 10px #DFF2BF;
|
||||||
|
color: #4F8A10;
|
||||||
|
padding: 4px 10px 4px 52px;
|
||||||
|
border-top-left-radius: 5px;
|
||||||
|
border-top-right-radius: 5px;
|
||||||
|
border-bottom-right-radius: 5px;
|
||||||
|
border-bottom-left-radius: 5px;
|
||||||
|
margin: 10px 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.note {
|
||||||
|
border: 1px solid;
|
||||||
|
background: url('../images/note.png') no-repeat 10px 10px #FFFCCB;
|
||||||
|
color: #9F6000;
|
||||||
|
padding: 4px 10px 4px 52px;
|
||||||
|
border-top-left-radius: 5px;
|
||||||
|
border-top-right-radius: 5px;
|
||||||
|
border-bottom-right-radius: 5px;
|
||||||
|
border-bottom-left-radius: 5px;
|
||||||
|
margin: 10px 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.warning {
|
||||||
|
border: 1px solid;
|
||||||
|
background: url('../images/warning.png') no-repeat 10px 10px #FFBABA;
|
||||||
|
color: #D8000C;
|
||||||
|
padding: 4px 10px 4px 52px;
|
||||||
|
border-top-left-radius: 5px;
|
||||||
|
border-top-right-radius: 5px;
|
||||||
|
border-bottom-right-radius: 5px;
|
||||||
|
border-bottom-left-radius: 5px;
|
||||||
|
margin: 10px 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.todo, .done {
|
||||||
|
margin: 10px 0;
|
||||||
|
padding: 0px 2px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.NEW {
|
||||||
|
background-color: #FDFCD8;
|
||||||
|
border: 1px solid #EEE9C3;
|
||||||
|
color: #302B13;
|
||||||
|
font-weight: normal;
|
||||||
|
}
|
||||||
|
|
||||||
|
.TODO {
|
||||||
|
background-color: #FED5D7;
|
||||||
|
border: 1px solid #FC5158;
|
||||||
|
color: #FC5158;
|
||||||
|
}
|
||||||
|
|
||||||
|
.STRT, .STARTED {
|
||||||
|
background-color: #FEF2D4;
|
||||||
|
border: 1px solid #FDBF3D;
|
||||||
|
color: #FDBF3D;
|
||||||
|
}
|
||||||
|
|
||||||
|
.WAIT, .WAITING, .DLGT, .DELEGATED {
|
||||||
|
background-color: #DFFFDF;
|
||||||
|
border: 1px solid #55BA80;
|
||||||
|
color: #55BA80;
|
||||||
|
}
|
||||||
|
|
||||||
|
.SDAY, .SOMEDAY, .DFRD, .DEFERRED {
|
||||||
|
background-color: #D3EEFF;
|
||||||
|
border: 1px solid #42B5FF;
|
||||||
|
color: #42B5FF;
|
||||||
|
}
|
||||||
|
|
||||||
|
.DONE, .CANX, .CANCELED {
|
||||||
|
background-color: #F2F2EE;
|
||||||
|
border: 1px solid #969696;
|
||||||
|
color: #969696;
|
||||||
|
}
|
||||||
|
|
||||||
|
.tag span {
|
||||||
|
background-color: #EDEDED;
|
||||||
|
border: 1px solid #EDEDED;
|
||||||
|
color: #939393;
|
||||||
|
cursor: pointer;
|
||||||
|
display: block;
|
||||||
|
float: right;
|
||||||
|
font-size: 80%;
|
||||||
|
font-weight: normal;
|
||||||
|
margin: 0 3px;
|
||||||
|
padding: 1px 2px;
|
||||||
|
border-radius: 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#right-panel-contents .tag span {
|
||||||
|
font-size: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.tag span:hover {
|
||||||
|
background: #BABDB6;
|
||||||
|
}
|
||||||
|
|
||||||
|
.tag .FLAGGED {
|
||||||
|
background-color: #EDC6C8;
|
||||||
|
border: 1px solid #EDC6C8;
|
||||||
|
color: #C15F4E;
|
||||||
|
}
|
||||||
|
|
||||||
|
.tag .selected {
|
||||||
|
background-color: #FFEBC1;
|
||||||
|
border: 1px solid #FDBF3B;
|
||||||
|
color: #A6750C;
|
||||||
|
}
|
||||||
|
|
||||||
|
#listOfTags .tag span {
|
||||||
|
display: inline;
|
||||||
|
float: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
span.todo {
|
||||||
|
cursor: pointer;
|
||||||
|
/* display: block; */
|
||||||
|
/* float: left; */
|
||||||
|
margin: -1px 3px 0px 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
span.todo:hover {
|
||||||
|
background: #BABDB6;
|
||||||
|
color: #888888;
|
||||||
|
}
|
||||||
|
|
||||||
|
span.todo .selected {
|
||||||
|
background-color: #FFEBC1;
|
||||||
|
border-color: #FDBF3B;
|
||||||
|
color: #A6750C;
|
||||||
|
}
|
||||||
|
|
||||||
|
.matchtag {
|
||||||
|
background-color: #FBFFC0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.matchNEW {
|
||||||
|
background-color: #FDFCD8;
|
||||||
|
}
|
||||||
|
|
||||||
|
.matchTODO {
|
||||||
|
background-color: #FFE6E4;
|
||||||
|
}
|
||||||
|
|
||||||
|
.matchSTRT {
|
||||||
|
background-color: #FEF2D4;
|
||||||
|
}
|
||||||
|
|
||||||
|
.matchWAIT, .matchDLGT {
|
||||||
|
background-color: #DFFFDF;
|
||||||
|
}
|
||||||
|
|
||||||
|
.matchSDAY, .matchDFRD {
|
||||||
|
background-color: #E0EFFF;
|
||||||
|
}
|
||||||
|
|
||||||
|
#listOfTodo, #listOfDone, #listOfTags {
|
||||||
|
/* bottom: 10px; /\* together with this to put the div at the bottom*\/ */
|
||||||
|
/* left: 10px; */
|
||||||
|
/* list-style-type: none; */
|
||||||
|
margin-left: 0px;
|
||||||
|
/* position: fixed; /\* this is the magic *\/ */
|
||||||
|
}
|
||||||
|
|
||||||
|
.timestamp-kwd {
|
||||||
|
background-color: #FFF1F1;
|
||||||
|
color: #880000;
|
||||||
|
margin: 0px 4px 0px 0px;
|
||||||
|
padding: 2px 0px 2px 2px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.timestamp {
|
||||||
|
color: #777777;
|
||||||
|
font-size: 80%;
|
||||||
|
}
|
||||||
|
|
||||||
|
#table-of-contents {
|
||||||
|
background-color: #FFFFDD;
|
||||||
|
border: 1px solid #E4E4E4;
|
||||||
|
display: table;
|
||||||
|
line-height: 1.2em;
|
||||||
|
padding: 4px;
|
||||||
|
margin: 4px;
|
||||||
|
max-width: 400px;
|
||||||
|
float: right;
|
||||||
|
width: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
#table-of-contents h2 {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
#table-of-contents ul {
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
#table-of-contents li {
|
||||||
|
list-style-type: none;
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
#table-of-contents li li {
|
||||||
|
margin-left: 1.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
#table-of-contents li li li {
|
||||||
|
font-size: 0.8em;
|
||||||
|
}
|
||||||
|
|
||||||
|
#table-of-contents a {
|
||||||
|
color: #606060;
|
||||||
|
font-size: 0.9em;
|
||||||
|
font-weight: normal;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
#table-of-contents a:hover {
|
||||||
|
color: #C61A1A;
|
||||||
|
text-decoration: underline;
|
||||||
|
}
|
||||||
|
|
||||||
|
#minitoc {
|
||||||
|
background-color: #FFFFDD;
|
||||||
|
border: 1px solid #E4E4E4;
|
||||||
|
color: #484848;
|
||||||
|
line-height: 1.2em;
|
||||||
|
margin: 12px;
|
||||||
|
padding: 4px;
|
||||||
|
position: fixed;
|
||||||
|
width: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
#minitoc a {
|
||||||
|
display: block;
|
||||||
|
font-size: 10px;
|
||||||
|
font-weight: normal;
|
||||||
|
}
|
||||||
|
|
||||||
|
#minitoc a {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
#minitoc:hover a {
|
||||||
|
display: block;
|
||||||
|
}
|
||||||
|
|
||||||
|
#minitoc h2 {
|
||||||
|
margin: 3px 0px;
|
||||||
|
border: none;
|
||||||
|
font-size: 11px;
|
||||||
|
}
|
||||||
|
|
||||||
|
p.verse {
|
||||||
|
color: #808080;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
.example {
|
||||||
|
background-color: #DDFADE;
|
||||||
|
border: 1px solid #9EC49F;
|
||||||
|
color: #333333;
|
||||||
|
}
|
||||||
|
|
||||||
|
.alert {
|
||||||
|
font-weight: bold;
|
||||||
|
color: #FF0000;
|
||||||
|
}
|
||||||
|
|
||||||
|
#toTop {
|
||||||
|
background: #F7F7F7;
|
||||||
|
border: 1px solid #CCCCCC;
|
||||||
|
top: 10px; /* together with this to put the div at the top */
|
||||||
|
color: #333333;
|
||||||
|
cursor: pointer;
|
||||||
|
display: none;
|
||||||
|
font-family: verdana;
|
||||||
|
font-size: 11px;
|
||||||
|
padding: 5px;
|
||||||
|
position: fixed; /* this is the magic */
|
||||||
|
right: 10px;
|
||||||
|
text-align: center;
|
||||||
|
width: 100px;
|
||||||
|
z-index: 999;
|
||||||
|
}
|
||||||
|
|
||||||
|
#toTop:hover {
|
||||||
|
text-decoration: underline;
|
||||||
|
}
|
||||||
|
|
||||||
|
#left-panel-wrapper {
|
||||||
|
position: fixed;
|
||||||
|
z-index: 200;
|
||||||
|
/* display: none; /\* hide the panel if Javascript is not running *\/ */
|
||||||
|
}
|
||||||
|
|
||||||
|
#left-panel-contents {
|
||||||
|
background-color: #EFEFEF;
|
||||||
|
border-right: 1px dotted #ADADAD;
|
||||||
|
display: none;
|
||||||
|
height: 100%;
|
||||||
|
left: 0px;
|
||||||
|
position: fixed;
|
||||||
|
text-align: left;
|
||||||
|
top: 0;
|
||||||
|
width: 199px;
|
||||||
|
z-index: 200;
|
||||||
|
padding-top: 7px;
|
||||||
|
padding-left: 7px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#left-panel-button {
|
||||||
|
transform: rotate(90deg);
|
||||||
|
background-color: #EFEFEF;
|
||||||
|
border: 1px dotted #ADADAD;
|
||||||
|
border-bottom-width: 0px;
|
||||||
|
left: -23px;
|
||||||
|
position: fixed;
|
||||||
|
top: 50%;
|
||||||
|
z-index: 200;
|
||||||
|
padding: 2px 5px 5px 5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#right-panel-wrapper {
|
||||||
|
position: fixed;
|
||||||
|
z-index: 200;
|
||||||
|
/* display: none; /\* hide the panel if Javascript is not running *\/ */
|
||||||
|
}
|
||||||
|
|
||||||
|
#right-panel-contents {
|
||||||
|
background-color: #EFEFEF;
|
||||||
|
border-left: 1px dotted #ADADAD;
|
||||||
|
display: none;
|
||||||
|
height: 100%;
|
||||||
|
right: 0px;
|
||||||
|
position: fixed;
|
||||||
|
text-align: left;
|
||||||
|
top: 0;
|
||||||
|
width: 199px;
|
||||||
|
z-index: 200;
|
||||||
|
padding-top: 7px;
|
||||||
|
padding-left: 7px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.org-src-container {
|
||||||
|
position: relative;
|
||||||
|
}
|
||||||
|
|
||||||
|
.snippet-copy-to-clipboard {
|
||||||
|
display: none;
|
||||||
|
position: absolute;
|
||||||
|
right: 10px;
|
||||||
|
top: 5px;
|
||||||
|
font-size: 0.9em;
|
||||||
|
text-decoration:underline;
|
||||||
|
}
|
||||||
|
|
||||||
|
.copy-to-clipboard-button:hover {
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* This is for the sake of Emacs. */
|
||||||
|
/* Local Variables: */
|
||||||
|
/* eval: (when (locate-library "rainbow-mode") (require 'rainbow-mode) (rainbow-mode)) */
|
||||||
|
/* End: */
|
116
org-html-themes/src/bigblow_theme/css/hideshow.css
Normal file
@ -0,0 +1,116 @@
|
|||||||
|
/* hideshow.css --- HideShow CSS file */
|
||||||
|
|
||||||
|
/* Copyright (C) 2014 All Right Reserved, Fabrice Niessen */
|
||||||
|
|
||||||
|
/* This file is free software: you can redistribute it and/or */
|
||||||
|
/* modify it under the terms of the GNU General Public License as */
|
||||||
|
/* published by the Free Software Foundation, either version 3 of */
|
||||||
|
/* the License, or (at your option) any later version. */
|
||||||
|
|
||||||
|
/* This file is distributed in the hope that it will be useful, */
|
||||||
|
/* but WITHOUT ANY WARRANTY; without even the implied warranty of */
|
||||||
|
/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
|
||||||
|
/* GNU General Public License for more details. */
|
||||||
|
|
||||||
|
/* Author: Fabrice Niessen <(concat "fniessen" at-sign "pirilampo.org")> */
|
||||||
|
/* URL: https://github.com/fniessen/hide-show/ */
|
||||||
|
/* Version: 20140912.1722 */
|
||||||
|
|
||||||
|
.hsExpanded.hsAnchor {background: #EE7700;}
|
||||||
|
|
||||||
|
.buttons {
|
||||||
|
padding: 0px 7px 13px 0px;
|
||||||
|
background: #0A3F69;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hsButton {
|
||||||
|
color: white;
|
||||||
|
float: right;
|
||||||
|
font-size: 70%;
|
||||||
|
margin-left: 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hsButton:hover {
|
||||||
|
background: #FBE448;
|
||||||
|
color: black;
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
|
|
||||||
|
.ellipsis {
|
||||||
|
color: #999999;
|
||||||
|
/* background-color: #FFF8C0; */
|
||||||
|
/* float: right; */
|
||||||
|
margin-left: 0.6em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hsReview {
|
||||||
|
border: 1px solid #A4A4A4;
|
||||||
|
background-color: white;
|
||||||
|
z-index: 500; /* must be greater then z-index of hsOverlay */
|
||||||
|
position: relative; /* required for z-index to work */
|
||||||
|
}
|
||||||
|
|
||||||
|
#hsOverlay {
|
||||||
|
width: 100%;
|
||||||
|
height: 100%;
|
||||||
|
position: fixed;
|
||||||
|
left: 0px;
|
||||||
|
top: 0px;
|
||||||
|
background-color: #000;
|
||||||
|
opacity: .70;
|
||||||
|
z-index: 250; /* must be greater than any other z-index (except the one for .hsReview */
|
||||||
|
}
|
||||||
|
|
||||||
|
.hsReviewPanel {
|
||||||
|
background-color: #757176;
|
||||||
|
color: white;
|
||||||
|
line-height: 1.1em;
|
||||||
|
margin: 10px 0px;
|
||||||
|
padding: 10px;
|
||||||
|
position: fixed;
|
||||||
|
width: auto;
|
||||||
|
bottom: 0px;
|
||||||
|
right: 0px;
|
||||||
|
z-index: 501;
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hsReviewPanel.hsReviewing {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hsReviewPanel:hover {
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hsReviewingPanel {
|
||||||
|
background-color: white;
|
||||||
|
color: #757176;
|
||||||
|
line-height: 1.1em;
|
||||||
|
margin: 10px 0px;
|
||||||
|
padding: 10px;
|
||||||
|
position: fixed;
|
||||||
|
width: auto;
|
||||||
|
bottom: 0px;
|
||||||
|
right: 0px;
|
||||||
|
z-index: 501;
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hsReviewButton:hover {
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hsUnselectable {
|
||||||
|
-webkit-touch-callout: none;
|
||||||
|
-webkit-user-select: none;
|
||||||
|
-khtml-user-select: none;
|
||||||
|
-moz-user-select: none;
|
||||||
|
-ms-user-select: none;
|
||||||
|
user-select: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* This is for the sake of Emacs. */
|
||||||
|
/* Local Variables: */
|
||||||
|
/* eval: (when (locate-library "rainbow-mode") (require 'rainbow-mode) (rainbow-mode)) */
|
||||||
|
/* End: */
|
145
org-html-themes/src/bigblow_theme/css/htmlize.css
Normal file
@ -0,0 +1,145 @@
|
|||||||
|
.org-bold { /* bold */ font-weight: bold; }
|
||||||
|
.org-bold-italic { /* bold-italic */ font-weight: bold; font-style: italic; }
|
||||||
|
.org-buffer-menu-buffer { /* buffer-menu-buffer */ font-weight: bold; }
|
||||||
|
.org-builtin { /* font-lock-builtin-face */ color: #7a378b; }
|
||||||
|
.org-button { /* button */ text-decoration: underline; }
|
||||||
|
.org-calendar-today { /* calendar-today */ text-decoration: underline; }
|
||||||
|
.org-change-log-acknowledgement { /* change-log-acknowledgement */ color: #b22222; }
|
||||||
|
.org-change-log-conditionals { /* change-log-conditionals */ color: #a0522d; }
|
||||||
|
.org-change-log-date { /* change-log-date */ color: #8b2252; }
|
||||||
|
.org-change-log-email { /* change-log-email */ color: #a0522d; }
|
||||||
|
.org-change-log-file { /* change-log-file */ color: #0000ff; }
|
||||||
|
.org-change-log-function { /* change-log-function */ color: #a0522d; }
|
||||||
|
.org-change-log-list { /* change-log-list */ color: #a020f0; }
|
||||||
|
.org-change-log-name { /* change-log-name */ color: #008b8b; }
|
||||||
|
.org-comint-highlight-input { /* comint-highlight-input */ font-weight: bold; }
|
||||||
|
.org-comint-highlight-prompt { /* comint-highlight-prompt */ color: #00008b; }
|
||||||
|
.org-comment { /* font-lock-comment-face */ color: #b22222; }
|
||||||
|
.org-comment-delimiter { /* font-lock-comment-delimiter-face */ color: #b22222; }
|
||||||
|
.org-completions-annotations { /* completions-annotations */ font-style: italic; }
|
||||||
|
.org-completions-common-part { /* completions-common-part */ color: #000000; background-color: #ffffff; }
|
||||||
|
.org-completions-first-difference { /* completions-first-difference */ font-weight: bold; }
|
||||||
|
.org-constant { /* font-lock-constant-face */ color: #008b8b; }
|
||||||
|
.org-diary { /* diary */ color: #ff0000; }
|
||||||
|
.org-diff-context { /* diff-context */ color: #7f7f7f; }
|
||||||
|
.org-diff-file-header { /* diff-file-header */ background-color: #b3b3b3; font-weight: bold; }
|
||||||
|
.org-diff-function { /* diff-function */ background-color: #cccccc; }
|
||||||
|
.org-diff-header { /* diff-header */ background-color: #cccccc; }
|
||||||
|
.org-diff-hunk-header { /* diff-hunk-header */ background-color: #cccccc; }
|
||||||
|
.org-diff-index { /* diff-index */ background-color: #b3b3b3; font-weight: bold; }
|
||||||
|
.org-diff-nonexistent { /* diff-nonexistent */ background-color: #b3b3b3; font-weight: bold; }
|
||||||
|
.org-diff-refine-change { /* diff-refine-change */ background-color: #d9d9d9; }
|
||||||
|
.org-dired-directory { /* dired-directory */ color: #0000ff; }
|
||||||
|
.org-dired-flagged { /* dired-flagged */ color: #ff0000; font-weight: bold; }
|
||||||
|
.org-dired-header { /* dired-header */ color: #228b22; }
|
||||||
|
.org-dired-ignored { /* dired-ignored */ color: #7f7f7f; }
|
||||||
|
.org-dired-mark { /* dired-mark */ color: #008b8b; }
|
||||||
|
.org-dired-marked { /* dired-marked */ color: #ff0000; font-weight: bold; }
|
||||||
|
.org-dired-perm-write { /* dired-perm-write */ color: #b22222; }
|
||||||
|
.org-dired-symlink { /* dired-symlink */ color: #a020f0; }
|
||||||
|
.org-dired-warning { /* dired-warning */ color: #ff0000; font-weight: bold; }
|
||||||
|
.org-doc { /* font-lock-doc-face */ color: #8b2252; }
|
||||||
|
.org-escape-glyph { /* escape-glyph */ color: #a52a2a; }
|
||||||
|
.org-file-name-shadow { /* file-name-shadow */ color: #7f7f7f; }
|
||||||
|
.org-flyspell-duplicate { /* flyspell-duplicate */ color: #cdad00; font-weight: bold; text-decoration: underline; }
|
||||||
|
.org-flyspell-incorrect { /* flyspell-incorrect */ color: #ff4500; font-weight: bold; text-decoration: underline; }
|
||||||
|
.org-fringe { /* fringe */ background-color: #f2f2f2; }
|
||||||
|
.org-function-name { /* font-lock-function-name-face */ color: #0000ff; }
|
||||||
|
.org-header-line { /* header-line */ color: #333333; background-color: #e5e5e5; }
|
||||||
|
.org-help-argument-name { /* help-argument-name */ font-style: italic; }
|
||||||
|
.org-highlight { /* highlight */ background-color: #b4eeb4; }
|
||||||
|
.org-holiday { /* holiday */ background-color: #ffc0cb; }
|
||||||
|
.org-isearch { /* isearch */ color: #b0e2ff; background-color: #cd00cd; }
|
||||||
|
.org-isearch-fail { /* isearch-fail */ background-color: #ffc1c1; }
|
||||||
|
.org-italic { /* italic */ font-style: italic; }
|
||||||
|
.org-keyword { /* font-lock-keyword-face */ color: #a020f0; }
|
||||||
|
.org-lazy-highlight { /* lazy-highlight */ background-color: #afeeee; }
|
||||||
|
.org-link { /* link */ color: #0000ff; text-decoration: underline; }
|
||||||
|
.org-link-visited { /* link-visited */ color: #8b008b; text-decoration: underline; }
|
||||||
|
.org-log-edit-header { /* log-edit-header */ color: #a020f0; }
|
||||||
|
.org-log-edit-summary { /* log-edit-summary */ color: #0000ff; }
|
||||||
|
.org-log-edit-unknown-header { /* log-edit-unknown-header */ color: #b22222; }
|
||||||
|
.org-match { /* match */ background-color: #ffff00; }
|
||||||
|
.org-next-error { /* next-error */ background-color: #eedc82; }
|
||||||
|
.org-nobreak-space { /* nobreak-space */ color: #a52a2a; text-decoration: underline; }
|
||||||
|
.org-org-archived { /* org-archived */ color: #7f7f7f; }
|
||||||
|
.org-org-block { /* org-block */ color: #7f7f7f; }
|
||||||
|
.org-org-block-begin-line { /* org-block-begin-line */ color: #b22222; }
|
||||||
|
.org-org-block-end-line { /* org-block-end-line */ color: #b22222; }
|
||||||
|
.org-org-checkbox { /* org-checkbox */ font-weight: bold; }
|
||||||
|
.org-org-checkbox-statistics-done { /* org-checkbox-statistics-done */ color: #228b22; font-weight: bold; }
|
||||||
|
.org-org-checkbox-statistics-todo { /* org-checkbox-statistics-todo */ color: #ff0000; font-weight: bold; }
|
||||||
|
.org-org-clock-overlay { /* org-clock-overlay */ background-color: #ffff00; }
|
||||||
|
.org-org-code { /* org-code */ color: #7f7f7f; }
|
||||||
|
.org-org-column { /* org-column */ background-color: #e5e5e5; }
|
||||||
|
.org-org-column-title { /* org-column-title */ background-color: #e5e5e5; font-weight: bold; text-decoration: underline; }
|
||||||
|
.org-org-date { /* org-date */ color: #a020f0; text-decoration: underline; }
|
||||||
|
.org-org-document-info { /* org-document-info */ color: #191970; }
|
||||||
|
.org-org-document-info-keyword { /* org-document-info-keyword */ color: #7f7f7f; }
|
||||||
|
.org-org-document-title { /* org-document-title */ color: #191970; font-size: 144%; font-weight: bold; }
|
||||||
|
.org-org-done { /* org-done */ color: #228b22; font-weight: bold; }
|
||||||
|
.org-org-drawer { /* org-drawer */ color: #0000ff; }
|
||||||
|
.org-org-ellipsis { /* org-ellipsis */ color: #b8860b; text-decoration: underline; }
|
||||||
|
.org-org-footnote { /* org-footnote */ color: #a020f0; text-decoration: underline; }
|
||||||
|
.org-org-formula { /* org-formula */ color: #b22222; }
|
||||||
|
.org-org-headline-done { /* org-headline-done */ color: #bc8f8f; }
|
||||||
|
.org-org-hide { /* org-hide */ color: #ffffff; }
|
||||||
|
.org-org-latex-and-export-specials { /* org-latex-and-export-specials */ color: #8b4513; }
|
||||||
|
.org-org-level-1 { /* org-level-1 */ color: #0000ff; }
|
||||||
|
.org-org-level-2 { /* org-level-2 */ color: #a0522d; }
|
||||||
|
.org-org-level-3 { /* org-level-3 */ color: #a020f0; }
|
||||||
|
.org-org-level-4 { /* org-level-4 */ color: #b22222; }
|
||||||
|
.org-org-level-5 { /* org-level-5 */ color: #228b22; }
|
||||||
|
.org-org-level-6 { /* org-level-6 */ color: #008b8b; }
|
||||||
|
.org-org-level-7 { /* org-level-7 */ color: #7a378b; }
|
||||||
|
.org-org-level-8 { /* org-level-8 */ color: #8b2252; }
|
||||||
|
.org-org-link { /* org-link */ color: #0000ff; text-decoration: underline; }
|
||||||
|
.org-org-meta-line { /* org-meta-line */ color: #b22222; }
|
||||||
|
.org-org-mode-line-clock { /* org-mode-line-clock */ color: #000000; background-color: #bfbfbf; }
|
||||||
|
.org-org-mode-line-clock-overrun { /* org-mode-line-clock-overrun */ color: #000000; background-color: #ff0000; }
|
||||||
|
.org-org-quote { /* org-quote */ color: #7f7f7f; }
|
||||||
|
.org-org-scheduled { /* org-scheduled */ color: #006400; }
|
||||||
|
.org-org-scheduled-previously { /* org-scheduled-previously */ color: #b22222; }
|
||||||
|
.org-org-scheduled-today { /* org-scheduled-today */ color: #006400; }
|
||||||
|
.org-org-sexp-date { /* org-sexp-date */ color: #a020f0; }
|
||||||
|
.org-org-special-keyword { /* org-special-keyword */ color: #a020f0; }
|
||||||
|
.org-org-table { /* org-table */ color: #0000ff; }
|
||||||
|
.org-org-tag { /* org-tag */ font-weight: bold; }
|
||||||
|
.org-org-target { /* org-target */ text-decoration: underline; }
|
||||||
|
.org-org-time-grid { /* org-time-grid */ color: #b8860b; }
|
||||||
|
.org-org-todo { /* org-todo */ color: #ff0000; font-weight: bold; }
|
||||||
|
.org-org-upcoming-deadline { /* org-upcoming-deadline */ color: #b22222; }
|
||||||
|
.org-org-verbatim { /* org-verbatim */ color: #7f7f7f; }
|
||||||
|
.org-org-verse { /* org-verse */ color: #7f7f7f; }
|
||||||
|
.org-org-warning { /* org-warning */ color: #ff0000; font-weight: bold; }
|
||||||
|
.org-outline-1 { /* outline-1 */ color: #0000ff; }
|
||||||
|
.org-outline-2 { /* outline-2 */ color: #a0522d; }
|
||||||
|
.org-outline-3 { /* outline-3 */ color: #a020f0; }
|
||||||
|
.org-outline-4 { /* outline-4 */ color: #b22222; }
|
||||||
|
.org-outline-5 { /* outline-5 */ color: #228b22; }
|
||||||
|
.org-outline-6 { /* outline-6 */ color: #008b8b; }
|
||||||
|
.org-outline-7 { /* outline-7 */ color: #7a378b; }
|
||||||
|
.org-outline-8 { /* outline-8 */ color: #8b2252; }
|
||||||
|
.org-preprocessor { /* font-lock-preprocessor-face */ color: #7a378b; }
|
||||||
|
.org-query-replace { /* query-replace */ color: #b0e2ff; background-color: #cd00cd; }
|
||||||
|
.org-regexp-grouping-backslash { /* font-lock-regexp-grouping-backslash */ font-weight: bold; }
|
||||||
|
.org-regexp-grouping-construct { /* font-lock-regexp-grouping-construct */ font-weight: bold; }
|
||||||
|
.org-region { /* region */ background-color: #eedc82; }
|
||||||
|
.org-secondary-selection { /* secondary-selection */ background-color: #ffff00; }
|
||||||
|
.org-shadow { /* shadow */ color: #7f7f7f; }
|
||||||
|
.org-show-paren-match { /* show-paren-match */ background-color: #40e0d0; }
|
||||||
|
.org-show-paren-mismatch { /* show-paren-mismatch */ color: #ffffff; background-color: #a020f0; }
|
||||||
|
.org-string { /* font-lock-string-face */ color: #8b2252; }
|
||||||
|
.org-tool-bar { /* tool-bar */ color: #000000; background-color: #bfbfbf; }
|
||||||
|
.org-tooltip { /* tooltip */ color: #000000; background-color: #ffffe0; }
|
||||||
|
.org-trailing-whitespace { /* trailing-whitespace */ background-color: #ff0000; }
|
||||||
|
.org-type { /* font-lock-type-face */ color: #228b22; }
|
||||||
|
.org-underline { /* underline */ text-decoration: underline; }
|
||||||
|
.org-variable-name { /* font-lock-variable-name-face */ color: #a0522d; }
|
||||||
|
.org-warning { /* font-lock-warning-face */ color: #ff0000; font-weight: bold; }
|
||||||
|
.org-widget-button { /* widget-button */ font-weight: bold; }
|
||||||
|
.org-widget-button-pressed { /* widget-button-pressed */ color: #ff0000; }
|
||||||
|
.org-widget-documentation { /* widget-documentation */ color: #006400; }
|
||||||
|
.org-widget-field { /* widget-field */ background-color: #d9d9d9; }
|
||||||
|
.org-widget-inactive { /* widget-inactive */ color: #7f7f7f; }
|
||||||
|
.org-widget-single-line-field { /* widget-single-line-field */ background-color: #d9d9d9; }
|
BIN
org-html-themes/src/bigblow_theme/images/checked.png
Normal file
After Width: | Height: | Size: 3.1 KiB |
BIN
org-html-themes/src/bigblow_theme/images/fixme.png
Normal file
After Width: | Height: | Size: 625 B |
BIN
org-html-themes/src/bigblow_theme/images/halfchecked.png
Normal file
After Width: | Height: | Size: 3.0 KiB |
BIN
org-html-themes/src/bigblow_theme/images/info.png
Normal file
After Width: | Height: | Size: 4.3 KiB |
BIN
org-html-themes/src/bigblow_theme/images/note.png
Normal file
After Width: | Height: | Size: 4.5 KiB |
BIN
org-html-themes/src/bigblow_theme/images/tip.png
Normal file
After Width: | Height: | Size: 4.3 KiB |
BIN
org-html-themes/src/bigblow_theme/images/unchecked.png
Normal file
After Width: | Height: | Size: 3.0 KiB |
BIN
org-html-themes/src/bigblow_theme/images/warning.png
Normal file
After Width: | Height: | Size: 4.2 KiB |
BIN
org-html-themes/src/bigblow_theme/js/ZeroClipboard.swf
Normal file
531
org-html-themes/src/bigblow_theme/js/bigblow.js
Normal file
@ -0,0 +1,531 @@
|
|||||||
|
// bigblow.js --- BigBlow JS file
|
||||||
|
//
|
||||||
|
// Copyright (C) 2011-2016 All Right Reserved, Fabrice Niessen
|
||||||
|
//
|
||||||
|
// This file is free software: you can redistribute it and/or
|
||||||
|
// modify it under the terms of the GNU General Public License as
|
||||||
|
// published by the Free Software Foundation, either version 3 of
|
||||||
|
// the License, or (at your option) any later version.
|
||||||
|
//
|
||||||
|
// This file is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// Author: Fabrice Niessen <(concat "fniessen" at-sign "pirilampo.org")>
|
||||||
|
// URL: https://github.com/fniessen/org-html-themes/
|
||||||
|
// Version: 20140515.1841
|
||||||
|
|
||||||
|
$(function() {
|
||||||
|
$('p').
|
||||||
|
html(function(index, old) {
|
||||||
|
return old.replace('FIXME',
|
||||||
|
'<span class="fixme">FIXME</span>');
|
||||||
|
});
|
||||||
|
$('p').
|
||||||
|
html(function(index, old) {
|
||||||
|
return old.replace('XXX',
|
||||||
|
'<span class="fixme">XXX</span>');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// Remove leading section number
|
||||||
|
$(function() {
|
||||||
|
$('.section-number-2').text("");
|
||||||
|
for (var i = 3; i <= 5; i++) {
|
||||||
|
$('.section-number-' + i).each(function() {
|
||||||
|
$(this).text($(this).text().replace(/^[0-9]+\./g, ""));
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
$(function() {
|
||||||
|
$('<div id="minitoc" class="dontprint"></div>').prependTo('body');
|
||||||
|
});
|
||||||
|
|
||||||
|
// generate contents of minitoc
|
||||||
|
function generateMiniToc(divId) {
|
||||||
|
$('#minitoc').empty().append('<h2>In this section</h2>');
|
||||||
|
$('#' + divId).find('h3').each(function(i) {
|
||||||
|
let pos = $(this).text().search(" ");
|
||||||
|
let text = $(this).text().substring(0, pos);
|
||||||
|
$("#minitoc").append("<a href='#" + $(this).attr("id") + "'>"
|
||||||
|
+ text + "</a>");
|
||||||
|
});
|
||||||
|
// Ensure that the target is expanded (hideShow)
|
||||||
|
$('#minitoc a[href^="#"]').click(function() {
|
||||||
|
var href = $(this).attr('href');
|
||||||
|
hsExpandAnchor(href);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// display tabs
|
||||||
|
function tabifySections() {
|
||||||
|
|
||||||
|
// hide TOC (if present)
|
||||||
|
$('#table-of-contents').hide();
|
||||||
|
|
||||||
|
// grab the list of `h2' from the page
|
||||||
|
var allSections = [];
|
||||||
|
$('h2')
|
||||||
|
.each(function() {
|
||||||
|
// Remove TODO keywords and tags (contained in spans)
|
||||||
|
var tabText = $(this).clone().find('span').remove().end()
|
||||||
|
.text().trim();
|
||||||
|
var tabId = $(this).parent().attr('id');
|
||||||
|
if (tabText) {
|
||||||
|
// - remove heading number (all leading digits)
|
||||||
|
// - remove progress logging (between square brackets)
|
||||||
|
// - remove leading and trailing spaces
|
||||||
|
tabText = tabText.replace(/^\d+\s+/, '').replace(/\[[\d/%]+\]/, '').trim();
|
||||||
|
|
||||||
|
allSections.push({
|
||||||
|
text: tabText,
|
||||||
|
id: tabId
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// create the tab links
|
||||||
|
var tabs = $('<ul id="tabs"></ul>');
|
||||||
|
for (i = 0; i < allSections.length; i++) {
|
||||||
|
var item = allSections[i];
|
||||||
|
html = $('<li><a href="#' + item.id + '">' + item.text + '</a></li>');
|
||||||
|
tabs.append(html);
|
||||||
|
}
|
||||||
|
|
||||||
|
// insert tabs menu after title (`h1'), or at the beginning of the content
|
||||||
|
if($('.title').length !== 0) {
|
||||||
|
$('.title').after(tabs);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$('#content').prepend(tabs);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function selectTabAndScroll(href) {
|
||||||
|
// At this point we assume that href is local (starts with #)
|
||||||
|
// alert(href);
|
||||||
|
|
||||||
|
// Find the tab to activate
|
||||||
|
var targetTab = $(href).closest('.ui-tabs-panel');
|
||||||
|
var targetTabId = targetTab.attr('id');
|
||||||
|
var targetTabAriaLabel = targetTab.attr('aria-labelledby');
|
||||||
|
|
||||||
|
var targetTabIndex = $("#content ul li")
|
||||||
|
.index($('[aria-labelledby="' + targetTabAriaLabel + '"]'));
|
||||||
|
|
||||||
|
// Activate target tab
|
||||||
|
$('#content').tabs('option', 'active', targetTabIndex);
|
||||||
|
|
||||||
|
// Rebuild minitoc
|
||||||
|
generateMiniToc(targetTabId);
|
||||||
|
|
||||||
|
// Set the location hash
|
||||||
|
// document.location.hash = href;
|
||||||
|
|
||||||
|
// Scroll to top if href was a tab
|
||||||
|
if (href == '#' + targetTabId) {
|
||||||
|
// alert(targetTabId);
|
||||||
|
$.scrollTo(0);
|
||||||
|
}
|
||||||
|
// Scroll to href if href was not a tab
|
||||||
|
else {
|
||||||
|
$.scrollTo(href);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$(document).ready(function() {
|
||||||
|
$('#preamble').remove();
|
||||||
|
$('#table-of-contents').remove();
|
||||||
|
|
||||||
|
// Prepare for tabs
|
||||||
|
tabifySections();
|
||||||
|
|
||||||
|
// Build the tabs from the #content div
|
||||||
|
$('#content').tabs();
|
||||||
|
|
||||||
|
// Set default animation
|
||||||
|
$('#content').tabs('option', 'show', true);
|
||||||
|
|
||||||
|
// Rebuild minitoc when a tab is activated
|
||||||
|
$('#content').tabs({
|
||||||
|
activate: function(event, ui) {
|
||||||
|
var divId = ui.newTab.attr('aria-controls');
|
||||||
|
generateMiniToc(divId);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Required to get the link of the tab in URL
|
||||||
|
$('#content ul').localScroll({
|
||||||
|
target: '#content',
|
||||||
|
duration: 0,
|
||||||
|
hash: true
|
||||||
|
});
|
||||||
|
|
||||||
|
// Handle hash in URL
|
||||||
|
if ($('#content') && document.location.hash) {
|
||||||
|
hsExpandAnchor(document.location.hash);
|
||||||
|
selectTabAndScroll(document.location.hash);
|
||||||
|
}
|
||||||
|
// If no hash, build the minitoc anyway for selected tab
|
||||||
|
else {
|
||||||
|
var divId = $('#content div[aria-expanded=true]').attr('id');
|
||||||
|
generateMiniToc(divId);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Handle click on internal links
|
||||||
|
$('.ui-tabs-panel a[href^="#"]').click(function(e) {
|
||||||
|
var href = $(this).attr('href');
|
||||||
|
hsExpandAnchor(href);
|
||||||
|
selectTabAndScroll(href);
|
||||||
|
e.preventDefault();
|
||||||
|
});
|
||||||
|
|
||||||
|
// Initialize hideShow
|
||||||
|
hsInit();
|
||||||
|
|
||||||
|
// add sticky headers to tables
|
||||||
|
$('table').stickyTableHeaders();
|
||||||
|
});
|
||||||
|
|
||||||
|
function copyToClipboard(text)
|
||||||
|
{
|
||||||
|
if (window.clipboardData && window.clipboardData.setData) { // Internet Explorer
|
||||||
|
window.clipboardData.setData("Text", text);
|
||||||
|
}
|
||||||
|
else { // Fallback solution
|
||||||
|
window.prompt("Copy to clipboard: Ctrl+C, Enter", text);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$(document).ready(function() {
|
||||||
|
// Assuming that the ZeroClipboard swf file is in the same folder than bigblow,
|
||||||
|
// get the path to it (it will be relative to the current page location).
|
||||||
|
var bbScriptPath = $('script[src$="bigblow.js"]').attr('src'); // the js file path
|
||||||
|
var bbPathToZeroClipboardSwf = bbScriptPath.replace('bigblow.js', 'ZeroClipboard.swf');
|
||||||
|
|
||||||
|
// Add copy to clipboard snippets
|
||||||
|
$('.org-src-container').prepend('<div class="snippet-copy-to-clipboard"><span class="copy-to-clipboard-button">[copy]</span></div>');
|
||||||
|
|
||||||
|
// Display/hide snippets on source block mouseenter/mouseleave
|
||||||
|
$(document).on('mouseenter', '.org-src-container', function () {
|
||||||
|
$(this).find('.snippet-copy-to-clipboard').show();
|
||||||
|
|
||||||
|
// Need to call zclip here, once the button is visible.
|
||||||
|
// Beacause when the button is not visible, zclip does nothing.
|
||||||
|
if ((window.location.protocol != 'file:') && ($(this).find('.zclip').length == 0)) {
|
||||||
|
$(this).find('.copy-to-clipboard-button').zclip({
|
||||||
|
//path: 'http://www.steamdev.com/zclip/js/ZeroClipboard.swf',
|
||||||
|
//path: 'src/bigblow_theme/js/ZeroClipboard.swf',
|
||||||
|
path: bbPathToZeroClipboardSwf,
|
||||||
|
copy: function() {
|
||||||
|
return $(this).parent().parent().find('.src').text();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}).on('mouseleave', '.org-src-container', function () {
|
||||||
|
$(this).find('.snippet-copy-to-clipboard').hide();
|
||||||
|
});
|
||||||
|
|
||||||
|
// Handle copy to clipboard (here, for a local file only 'file://...'
|
||||||
|
if (window.location.protocol == 'file:') { // if local file use browser-specific code
|
||||||
|
$('.copy-to-clipboard-button').click(function() {
|
||||||
|
// Get the text to be copied
|
||||||
|
var text = $(this).parent().parent().find('.src').text();
|
||||||
|
text = text.replace(/\n/g, "\r\n");
|
||||||
|
// alert(text);
|
||||||
|
copyToClipboard(text);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
$(function() {
|
||||||
|
$('li > code :contains("[X]")')
|
||||||
|
.parent()
|
||||||
|
.addClass('checked')
|
||||||
|
.end()
|
||||||
|
.remove();
|
||||||
|
$('li > code :contains("[-]")')
|
||||||
|
.parent()
|
||||||
|
.addClass('halfchecked')
|
||||||
|
.end()
|
||||||
|
.remove();
|
||||||
|
$('li > code :contains("[ ]")')
|
||||||
|
.parent()
|
||||||
|
.addClass('unchecked')
|
||||||
|
.end()
|
||||||
|
.remove();
|
||||||
|
});
|
||||||
|
|
||||||
|
$(function() {
|
||||||
|
$('i :contains("[#A]")')
|
||||||
|
.replaceWith('<i><span style="color: #F67777;">[#A]</span></i>');
|
||||||
|
$('i :contains("[#B]")')
|
||||||
|
.replaceWith('<i><span style="color: #B6E864;">[#B]</span></i>');
|
||||||
|
$('i :contains("[#C]")')
|
||||||
|
.replaceWith('<i><span style="color: #C3DCFF;">[#C]</span></i>');
|
||||||
|
});
|
||||||
|
|
||||||
|
$(function() {
|
||||||
|
$('<div id="toTop" class="dontprint"><span>^ Back to Top</span></div>').appendTo('body');
|
||||||
|
|
||||||
|
$(window).scroll(function() {
|
||||||
|
if ($(this).scrollTop() != 0) {
|
||||||
|
$('#toTop').fadeIn();
|
||||||
|
} else {
|
||||||
|
$('#toTop').fadeOut();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
$('#toTop').click(function(e) {
|
||||||
|
$('html, body').animate({scrollTop: 0}, 800);
|
||||||
|
e.preventDefault(); // Disable default browser behavior
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
function togglePanel(e) {
|
||||||
|
e.preventDefault();
|
||||||
|
|
||||||
|
$("#left-panel-contents").toggleClass('active').toggle(200);
|
||||||
|
$("#right-panel-contents").toggleClass('active').toggle(200);
|
||||||
|
|
||||||
|
var slidePos =
|
||||||
|
$("#left-panel-button").css("left") == "-23px"? '182px': '-23px';
|
||||||
|
|
||||||
|
$("#left-panel-button").
|
||||||
|
animate({"left": slidePos, "opacity": 0.9}, {duration: "200" });
|
||||||
|
|
||||||
|
// if ($("#left-panel-contents").hasClass('active')) {
|
||||||
|
// hsHideTodoKeyword('done');
|
||||||
|
// } else {
|
||||||
|
// hsShowTodoKeyword('done');
|
||||||
|
// }
|
||||||
|
|
||||||
|
// return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
$(function() {
|
||||||
|
$('<div id="left-panel-wrapper" class="dontprint"><div id="left-panel-contents" style="opacity: 0.9"></div><div id="left-panel-button" class="dontprint"><a href="#">Dashboard</a></div></div>')
|
||||||
|
.appendTo('body');
|
||||||
|
|
||||||
|
$('<div id="right-panel-wrapper" class="dontprint"><div id="right-panel-contents" style="opacity: 0.9"></div></div>')
|
||||||
|
.appendTo('body');
|
||||||
|
|
||||||
|
$('#left-panel-button').click(togglePanel);
|
||||||
|
});
|
||||||
|
|
||||||
|
$(function() {
|
||||||
|
var ul = $('<ul id="listOfTodo"></ul>').appendTo('#left-panel-contents');
|
||||||
|
var countOfTodo = {}, listOfTodo = [], totalOfTodo = 0;
|
||||||
|
|
||||||
|
// assign the counts (avoid double-counting elements from the ToC)
|
||||||
|
$('span.todo').not($('#table-of-contents span.todo')).each(function() {
|
||||||
|
var $thisTodo = $(this).text().trim();
|
||||||
|
|
||||||
|
if ($.inArray($thisTodo, listOfTodo) == -1) {
|
||||||
|
countOfTodo[$thisTodo] = 1;
|
||||||
|
listOfTodo.push($thisTodo);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
countOfTodo[$thisTodo] += 1;
|
||||||
|
totalOfTodo += 1;
|
||||||
|
});
|
||||||
|
|
||||||
|
function scoreTodo(t) {
|
||||||
|
switch (t) {
|
||||||
|
case 'NEW': return 1;
|
||||||
|
case 'TODO': return 2;
|
||||||
|
case 'STRT': return 3;
|
||||||
|
case 'WAIT': return 4;
|
||||||
|
case 'DLGT': return 5;
|
||||||
|
case 'SDAY': return 6;
|
||||||
|
case 'DFRD': return 7;
|
||||||
|
case 'DONE': return 8;
|
||||||
|
case 'CANX': return 9;
|
||||||
|
default: return 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function compareTodo(a, b) {
|
||||||
|
if (scoreTodo(a) < scoreTodo(b)) return -1;
|
||||||
|
if (scoreTodo(a) > scoreTodo(b)) return 1;
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
listOfTodo.sort(compareTodo);
|
||||||
|
|
||||||
|
// display
|
||||||
|
for (i = 0; i < listOfTodo.length; i++) {
|
||||||
|
var $thisTodo = listOfTodo[i];
|
||||||
|
$(ul).append('<li><span class="todo ' + $thisTodo + '">'+ $thisTodo + '</span>'
|
||||||
|
+ ' <small>(' + countOfTodo[$thisTodo] + ')</small></li>');
|
||||||
|
}
|
||||||
|
|
||||||
|
$('#listOfTodo')
|
||||||
|
.before('<b>Next Actions</b> <small>(' + totalOfTodo + ')</small>:<br>');
|
||||||
|
});
|
||||||
|
|
||||||
|
$(function() {
|
||||||
|
var ul = $('<ul id="listOfDone"></ul>').appendTo('#left-panel-contents');
|
||||||
|
var countOfDone = {}, listOfDone = [], totalOfDone = 0;
|
||||||
|
|
||||||
|
// assign the counts (avoid double-counting elements from the ToC)
|
||||||
|
$('span.done').not($('#table-of-contents span.done')).each(function() {
|
||||||
|
var $thisDone = $(this).text().trim();
|
||||||
|
|
||||||
|
if ($.inArray($thisDone, listOfDone) == -1) {
|
||||||
|
countOfDone[$thisDone] = 1;
|
||||||
|
listOfDone.push($thisDone);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
countOfDone[$thisDone] += 1;
|
||||||
|
totalOfDone += 1;
|
||||||
|
});
|
||||||
|
|
||||||
|
// display
|
||||||
|
for (i = 0; i < listOfDone.length; i++) {
|
||||||
|
var $thisDone = listOfDone[i];
|
||||||
|
$(ul).append('<li><span class="done ' + $thisDone + '">'+ $thisDone + '</span>'
|
||||||
|
+ ' <small>(' + countOfDone[$thisDone] + ')</small></li>');
|
||||||
|
}
|
||||||
|
|
||||||
|
$('#listOfDone')
|
||||||
|
.before('<b>Done Actions</b> <small>(' + totalOfDone + '):</small><br>');
|
||||||
|
});
|
||||||
|
|
||||||
|
$(function() {
|
||||||
|
var ul = $('<ul id="listOfTags"></ul>').appendTo('#right-panel-contents');
|
||||||
|
var countOfTags = {}, listOfTags = [], totalOfTags = 0;
|
||||||
|
|
||||||
|
// assign the counts (avoid double-counting elements from the ToC)
|
||||||
|
$('span.tag').not($('#table-of-contents span.tag')).each(function() {
|
||||||
|
var $thisTagGroup = $(this).text().trim().split(/\s/);
|
||||||
|
// \s matches spaces, tabs, new lines, etc.
|
||||||
|
|
||||||
|
for (tag in $thisTagGroup) {
|
||||||
|
if ($.inArray($thisTagGroup[tag], listOfTags) == -1) {
|
||||||
|
countOfTags[$thisTagGroup[tag]] = 1;
|
||||||
|
listOfTags.push($thisTagGroup[tag]);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
countOfTags[$thisTagGroup[tag]] += 1;
|
||||||
|
totalOfTags += 1;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
listOfTags.sort();
|
||||||
|
|
||||||
|
// display
|
||||||
|
for (i = 0; i < listOfTags.length; i++) {
|
||||||
|
var $thisTag = listOfTags[i];
|
||||||
|
// $(ul).append('<li><span class="tag ' + $thisTag + '">'+
|
||||||
|
// $thisTag + '</span> <small>(' + countOfTags[$thisTag] + ')</small></li>');
|
||||||
|
$(ul).append('<li><span class="tag"><span class="' + $thisTag + '">' + $thisTag
|
||||||
|
+ '</span></span>'
|
||||||
|
+ ' <small>(' + countOfTags[$thisTag] + ')</small></li>');
|
||||||
|
}
|
||||||
|
|
||||||
|
$('#listOfTags')
|
||||||
|
.before('<b>Contexts</b> <small>(' + totalOfTags + '):</small><br>');
|
||||||
|
});
|
||||||
|
|
||||||
|
$(function() {
|
||||||
|
$('.done').parent(':header').parent().find(':header').addClass('DONEheader');
|
||||||
|
$('.done').parent(':header').parent().css({color: '#999999'});
|
||||||
|
});
|
||||||
|
|
||||||
|
$(function() {
|
||||||
|
$('span.todo').click(function(e) {
|
||||||
|
var orgKeyword = $(this).text().trim();
|
||||||
|
$('.' + orgKeyword).toggleClass('selected');
|
||||||
|
$('#content .' + orgKeyword).parent().parent()
|
||||||
|
.toggleClass('match' + orgKeyword);
|
||||||
|
$('#left-panel-wrapper .' + orgKeyword).parent()
|
||||||
|
.toggleClass('match' + orgKeyword);
|
||||||
|
e.preventDefault();
|
||||||
|
})
|
||||||
|
});
|
||||||
|
|
||||||
|
$(function() {
|
||||||
|
$('.tag span').click(function(e) {
|
||||||
|
var orgTag = $(this).text().trim();
|
||||||
|
$('.' + orgTag).toggleClass('selected');
|
||||||
|
$('#content .' + orgTag).parent().parent().parent()
|
||||||
|
.toggleClass('matchtag');
|
||||||
|
$('#right-panel-wrapper .' + orgTag).parent().parent()
|
||||||
|
.toggleClass('matchtag');
|
||||||
|
e.preventDefault();
|
||||||
|
})
|
||||||
|
});
|
||||||
|
|
||||||
|
function clickPreviousTab() {
|
||||||
|
var active = $('#content').tabs('option', 'active');
|
||||||
|
// Avoid going back to last tab
|
||||||
|
if (active == 0) return;
|
||||||
|
|
||||||
|
$('#content').tabs('option', 'active', active - 1);
|
||||||
|
|
||||||
|
// Set the location href
|
||||||
|
var href = $('#content div[aria-expanded=true]').attr('id');
|
||||||
|
document.location.hash = href;
|
||||||
|
$.scrollTo(0);
|
||||||
|
}
|
||||||
|
|
||||||
|
function clickNextTab() {
|
||||||
|
var active = $('#content').tabs('option', 'active');
|
||||||
|
$('#content').tabs('option', 'active', active + 1);
|
||||||
|
|
||||||
|
// Set the location href
|
||||||
|
var href = $('#content div[aria-expanded=true]').attr('id');
|
||||||
|
document.location.hash = href;
|
||||||
|
$.scrollTo(0);
|
||||||
|
}
|
||||||
|
|
||||||
|
function orgDefkey(e) {
|
||||||
|
if (!e)
|
||||||
|
var e = window.event;
|
||||||
|
var keycode = (e.keyCode) ? e.keyCode : e.which;
|
||||||
|
var actualkey = String.fromCharCode(keycode);
|
||||||
|
switch (actualkey) {
|
||||||
|
case "?": // help (dashboard)
|
||||||
|
case "h":
|
||||||
|
togglePanel(e);
|
||||||
|
break;
|
||||||
|
case "n": // next
|
||||||
|
clickNextTab();
|
||||||
|
break;
|
||||||
|
case "p": // previous
|
||||||
|
clickPreviousTab();
|
||||||
|
break;
|
||||||
|
// case "b": // scroll down - should be mapped to Shift-SPC
|
||||||
|
// $(window).scrollTop($(window).scrollTop()-$(window).height());
|
||||||
|
// break;
|
||||||
|
case "<": // scroll to top
|
||||||
|
$(window).scrollTop(0);
|
||||||
|
break;
|
||||||
|
case ">": // scroll to bottom
|
||||||
|
$(window).scrollTop($(document).height());
|
||||||
|
break;
|
||||||
|
case "-": // collapse all
|
||||||
|
hsCollapseAll();
|
||||||
|
break;
|
||||||
|
case "+": // expand all
|
||||||
|
hsExpandAll();
|
||||||
|
break;
|
||||||
|
case "r": // go to next task
|
||||||
|
hsReviewTaskNext();
|
||||||
|
break;
|
||||||
|
case "R": // go to previous task
|
||||||
|
hsReviewTaskPrev();
|
||||||
|
break;
|
||||||
|
case "q": // quit reviewing
|
||||||
|
hsReviewTaskQuit();
|
||||||
|
break;
|
||||||
|
case "g": // refresh the page (from the server, rather than the cache)
|
||||||
|
location.reload(true);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
document.onkeypress = orgDefkey;
|
334
org-html-themes/src/bigblow_theme/js/hideshow.js
Normal file
@ -0,0 +1,334 @@
|
|||||||
|
// hideshow.js --- HideShow JS file
|
||||||
|
//
|
||||||
|
// Copyright (C) 2014-2020 All Right Reserved, Fabrice Niessen
|
||||||
|
//
|
||||||
|
// This file is free software: you can redistribute it and/or
|
||||||
|
// modify it under the terms of the GNU General Public License as
|
||||||
|
// published by the Free Software Foundation, either version 3 of
|
||||||
|
// the License, or (at your option) any later version.
|
||||||
|
//
|
||||||
|
// This file is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// Author: Fabrice Niessen <(concat "fniessen" at-sign "pirilampo.org")>
|
||||||
|
// URL: https://github.com/fniessen/hide-show/
|
||||||
|
// Version: 20140912.1722
|
||||||
|
|
||||||
|
// var HS_COLLAPSIBLE_HEADERS = $('h3, h4, h5'); // collapsible headers
|
||||||
|
|
||||||
|
if (typeof HS_STARTUP_FOLDED === 'undefined') {
|
||||||
|
var HS_STARTUP_FOLDED = false; // Show just the overview, or show all.
|
||||||
|
}
|
||||||
|
|
||||||
|
if (typeof HS_SHOW_ALL_TEXT === 'undefined') {
|
||||||
|
var HS_SHOW_ALL_TEXT = '[Expand all]';
|
||||||
|
}
|
||||||
|
if (typeof HS_HIDE_ALL_TEXT === 'undefined') {
|
||||||
|
var HS_HIDE_ALL_TEXT = '[Collapse all]';
|
||||||
|
}
|
||||||
|
|
||||||
|
if (typeof HS_ALWAYS_DISPLAY_ICON === 'undefined') {
|
||||||
|
var HS_ALWAYS_DISPLAY_ICON = false; // Display an icon for all states, or
|
||||||
|
// just when closed.
|
||||||
|
}
|
||||||
|
|
||||||
|
if (typeof HS_ICON_CLOSED === 'undefined') {
|
||||||
|
var HS_ICON_CLOSED = '►'; // black right-pointing pointer
|
||||||
|
}
|
||||||
|
if (typeof HS_ICON_OPEN === 'undefined') {
|
||||||
|
var HS_ICON_OPEN = '▼'; // black down-pointing triangle
|
||||||
|
}
|
||||||
|
if (typeof HS_ICON_EMPTY === 'undefined') {
|
||||||
|
var HS_ICON_EMPTY = '■'; // black square
|
||||||
|
}
|
||||||
|
|
||||||
|
if (typeof HS_SHOW_ALL_OPEN_DONE_TREES === 'undefined') {
|
||||||
|
var HS_SHOW_ALL_OPEN_DONE_TREES = false; // Expand all will open DONE trees.
|
||||||
|
}
|
||||||
|
|
||||||
|
if (typeof HS_CLASS === 'undefined') {
|
||||||
|
var HS_CLASS = 'hsCollapsible';
|
||||||
|
}
|
||||||
|
|
||||||
|
// Expand a header
|
||||||
|
function hsExpand(header) {
|
||||||
|
hsExpand2(header, true);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Expand a header
|
||||||
|
function hsExpand2(header, expandDoneHeader) {
|
||||||
|
// Ignore non collapsible entries
|
||||||
|
if (!header.parent().hasClass(HS_CLASS)) return;
|
||||||
|
|
||||||
|
// Do not expand DONE node if not required
|
||||||
|
if (hsIsDoneHeader(header) && !expandDoneHeader) return;
|
||||||
|
|
||||||
|
header.children('span[class="ellipsis"]').remove();
|
||||||
|
if (HS_ALWAYS_DISPLAY_ICON == true) {
|
||||||
|
header.append('<span class="ellipsis"> ' + HS_ICON_OPEN + '</span>');
|
||||||
|
}
|
||||||
|
header.parent().removeClass('hsCollapsed').addClass('hsExpanded');
|
||||||
|
header.nextAll().show();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Expand a header and all its parents
|
||||||
|
function hsExpandParents(header) {
|
||||||
|
hsExpand(header);
|
||||||
|
header.parents('.hsCollapsed').each(function() {
|
||||||
|
hsExpand($(this).children(':header'));
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// Collapse a header and all its parents
|
||||||
|
function hsCollapseParents(header) {
|
||||||
|
hsCollapse(header);
|
||||||
|
header.parents('.hsExpanded').each(function() {
|
||||||
|
hsCollapse($(this).children(':header'));
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// Collapse a header
|
||||||
|
function hsCollapse(header) {
|
||||||
|
// Ignore non collapsible entries
|
||||||
|
if (!header.parent().hasClass(HS_CLASS)) return;
|
||||||
|
|
||||||
|
header.children('span[class="ellipsis"]').remove();
|
||||||
|
header.append('<span class="ellipsis"> ' + HS_ICON_CLOSED + '</span>');
|
||||||
|
header.parent().removeClass('hsExpanded').addClass('hsCollapsed');
|
||||||
|
// header.nextAll().hide('fast');
|
||||||
|
header.nextAll().hide();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Toggle a header
|
||||||
|
function hsToggleCollapsing(header) {
|
||||||
|
if (header.parent().hasClass('hsCollapsed'))
|
||||||
|
hsExpand(header);
|
||||||
|
else if (header.parent().hasClass('hsExpanded'))
|
||||||
|
hsCollapse(header);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Expand all headers
|
||||||
|
function hsExpandAll() {
|
||||||
|
$('#content .hsCollapsed').each(function() {
|
||||||
|
hsExpand2($(this).children(':header'), HS_SHOW_ALL_OPEN_DONE_TREES);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// Collapse all headers
|
||||||
|
function hsCollapseAll() {
|
||||||
|
$('#content .hsExpanded').each(function() {
|
||||||
|
hsCollapse($(this).children(':header'));
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// Collapse all visible headers
|
||||||
|
function hsCollapseAllVisible() {
|
||||||
|
$('#content .hsExpanded:visible').each(function() {
|
||||||
|
hsCollapse($(this).children(':header'));
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// Add click events to H3/H4/H5 headers which have contents.
|
||||||
|
function hsInit() {
|
||||||
|
for (var i = 3; i <= 5; i++) {
|
||||||
|
$('#content .outline-' + i).each(function() {
|
||||||
|
var header = $(this).children(':header');
|
||||||
|
if (header.siblings().length > 0) {
|
||||||
|
$(this).addClass(HS_CLASS);
|
||||||
|
header.css({cursor: 'pointer'});
|
||||||
|
header.click(function() {
|
||||||
|
hsToggleCollapsing($(this)); });
|
||||||
|
|
||||||
|
// Allow to override global Collapse/Expand default on an entry
|
||||||
|
// basis (see property `:HTML_CONTAINER_CLASS:')
|
||||||
|
if (header.parent().hasClass('hsCollapsed')) {
|
||||||
|
hsCollapse(header);
|
||||||
|
} else if (header.parent().hasClass('hsExpanded')) {
|
||||||
|
hsExpand(header);
|
||||||
|
} else {
|
||||||
|
hsSetDefaultVisibility(header);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
if (HS_ALWAYS_DISPLAY_ICON == true) {
|
||||||
|
header.append('<span class="ellipsis"> ' + HS_ICON_EMPTY
|
||||||
|
+ '</span>');
|
||||||
|
}
|
||||||
|
$(this).addClass('hsEmpty');
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// Add buttons
|
||||||
|
$('.title').after($('<div class="buttons dontprint"></div>'));
|
||||||
|
$('.buttons').append($('<span>' + HS_SHOW_ALL_TEXT + '</span>')
|
||||||
|
.addClass('hsButton')
|
||||||
|
.click(hsExpandAll));
|
||||||
|
$('.buttons').append($('<span>' + HS_HIDE_ALL_TEXT + '</span>')
|
||||||
|
.addClass('hsButton')
|
||||||
|
.click(hsCollapseAll));
|
||||||
|
}
|
||||||
|
|
||||||
|
// Returns true if a header is a DONE header
|
||||||
|
function hsIsDoneHeader(header) {
|
||||||
|
return $('span.done', header).length;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sets the default visibility state to a header
|
||||||
|
function hsSetDefaultVisibility(header) {
|
||||||
|
if (HS_STARTUP_FOLDED) {
|
||||||
|
hsCollapse(header);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
if (!hsIsDoneHeader(header) | HS_SHOW_ALL_OPEN_DONE_TREES) {
|
||||||
|
hsExpand(header);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
hsCollapse(header);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Expands an anchor, i.e. expand all parent headers
|
||||||
|
function hsExpandAnchor(id) {
|
||||||
|
// alert(id);
|
||||||
|
if (id) {
|
||||||
|
// alert($(id + '.hsNode').length);
|
||||||
|
$(id).parents('.hsCollapsed').each(function() {
|
||||||
|
hsExpand2($(this).children(':header'), true);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Search for next task to review, starting from beginning of current tab.
|
||||||
|
// If BACKWARD is true, search in the reverse direction.
|
||||||
|
function hsReviewTaskNext(backward) {
|
||||||
|
// If no tasks to review at all, do nothing.
|
||||||
|
if ($('.outline-2 span.todo').length == 0) return;
|
||||||
|
|
||||||
|
if ($('.hsReviewing').length == 0) { // reviewing is starting
|
||||||
|
$('body').addClass('hsReviewing');
|
||||||
|
$('.hsReviewPanel').addClass('hsReviewing');
|
||||||
|
$('body').prepend('<div id="hsOverlay"></div>');
|
||||||
|
hsAddReviewingPanels();
|
||||||
|
|
||||||
|
hsCollapseAll();
|
||||||
|
// Get first task to review on each tab and expand it
|
||||||
|
$('.outline-2').each(function(){
|
||||||
|
var firstTodo = $(this).find('span.todo:first').parent().parent();
|
||||||
|
firstTodo.addClass('hsReview');
|
||||||
|
hsExpandParents($(firstTodo).children(':header'));
|
||||||
|
});
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
// Get all todos
|
||||||
|
var todosElements = $('.outline-2:visible span.todo').parent().parent();
|
||||||
|
// alert(todosElements.length);
|
||||||
|
var todos = jQuery.makeArray(todosElements);
|
||||||
|
if (backward) {
|
||||||
|
todos = todos.reverse();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Find current review item and review the next one
|
||||||
|
var foundReview = false;
|
||||||
|
var index;
|
||||||
|
for (index = 0; index < todos.length; ++index) {
|
||||||
|
var todo = todos[index];
|
||||||
|
if (foundReview) {
|
||||||
|
$(todo).addClass('hsReview');
|
||||||
|
hsExpandParents($(todo).children(':header'));
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
if ($(todo).hasClass('hsReview')) {
|
||||||
|
foundReview = true;
|
||||||
|
if (index < todos.length - 1) {
|
||||||
|
$(todo).removeClass('hsReview');
|
||||||
|
hsCollapseParents($(todo).children(':header'));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Update reviewing panel
|
||||||
|
if (index < todos.length) {
|
||||||
|
var reviewItem = index + 1;
|
||||||
|
if (backward) {
|
||||||
|
reviewItem = todos.length - index;
|
||||||
|
}
|
||||||
|
|
||||||
|
$('.outline-2:visible .hsReviewingPanel .hsReviewItem').text(reviewItem);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Scroll to the current review item
|
||||||
|
$('html, body').animate({
|
||||||
|
scrollTop: $(".hsReview:visible").offset().top
|
||||||
|
}, 200);
|
||||||
|
}
|
||||||
|
|
||||||
|
// go to previous task to review
|
||||||
|
function hsReviewTaskPrev() {
|
||||||
|
hsReviewTaskNext(true);
|
||||||
|
}
|
||||||
|
|
||||||
|
// stop reviewing tasks
|
||||||
|
function hsReviewTaskQuit() {
|
||||||
|
$('body').removeClass('hsReviewing');
|
||||||
|
$('.hsReviewPanel').removeClass('hsReviewing');
|
||||||
|
$('.hsReview').removeClass('hsReview');
|
||||||
|
$('#hsOverlay').remove();
|
||||||
|
$('.hsReviewingPanel').remove();
|
||||||
|
}
|
||||||
|
|
||||||
|
function hsHideTodoKeyword(kw) {
|
||||||
|
$('span.' + kw).addClass('hsHidden').parent().parent().hide();
|
||||||
|
}
|
||||||
|
|
||||||
|
function hsShowTodoKeyword(kw) {
|
||||||
|
$('span.' + kw).removeClass('hsHidden').parent().parent().show();
|
||||||
|
// XXX Show if parent is not collapsed!
|
||||||
|
}
|
||||||
|
|
||||||
|
function hsAddReviewPanels() {
|
||||||
|
$('.outline-2').each(function(e) {
|
||||||
|
var nbItems = $(this).find('span.todo').length;
|
||||||
|
if (nbItems > 0) {
|
||||||
|
$(this).prepend('<div class="hsReviewPanel hsUnselectable" onclick="hsReviewTaskNext()">'
|
||||||
|
+ 'Press r or click here<br>'
|
||||||
|
+ 'to review ' + nbItems + ' tasks<br>'
|
||||||
|
+ '(out of ' + nbReviewTotalTasks + ' tasks)</div>');
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function hsAddReviewingPanels() {
|
||||||
|
$('.outline-2').each(function(e) {
|
||||||
|
var nbItems = $(this).find('span.todo').length;
|
||||||
|
if (nbItems > 0) {
|
||||||
|
$(this).prepend('<div class="hsReviewingPanel hsUnselectable">Reviewing task <span class="hsReviewItem">1</span> / ' + nbItems + '<br>'
|
||||||
|
+ '(out of ' + nbReviewTotalTasks + ' tasks)<br>'
|
||||||
|
+ 'Shortcuts: '
|
||||||
|
+ '<span class="hsReviewButton" onclick="hsReviewTaskNext()">r (next)</span> - '
|
||||||
|
+ '<span class="hsReviewButton" onclick="hsReviewTaskPrev()">R (previous)</span><br>'
|
||||||
|
+ '<span class="hsReviewButton" onclick="hsReviewTaskPrev()">q (quit)</span>'
|
||||||
|
+ '</div>');
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
$(this).prepend('<div class="hsReviewingPanel hsUnselectable">No task to review<br>'
|
||||||
|
+ '(out of ' + nbReviewTotalTasks + ' tasks)<br>'
|
||||||
|
+ 'Shortcuts: '
|
||||||
|
+ '<span class="hsReviewButton" onclick="hsReviewTaskNext()">r (next)</span> - '
|
||||||
|
+ '<span class="hsReviewButton" onclick="hsReviewTaskPrev()">R (previous)</span><br>'
|
||||||
|
+ '<span class="hsReviewButton" onclick="hsReviewTaskPrev()">q (quit)</span>'
|
||||||
|
+ '</div>');
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
var nbReviewTotalTasks;
|
||||||
|
|
||||||
|
$(document).ready(function() {
|
||||||
|
nbReviewTotalTasks = $('.outline-2 span.todo').length;
|
||||||
|
hsAddReviewPanels();
|
||||||
|
});
|
4
org-html-themes/src/bigblow_theme/js/jquery-1.11.0.min.js
vendored
Normal file
5
org-html-themes/src/bigblow_theme/js/jquery-1.9.1.min.js
vendored
Normal file
12
org-html-themes/src/bigblow_theme/js/jquery-ui-1.10.2.min.js
vendored
Normal file
9
org-html-themes/src/bigblow_theme/js/jquery.localscroll-min.js
vendored
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
/**
|
||||||
|
* jQuery.LocalScroll - Animated scrolling navigation, using anchors.
|
||||||
|
* Copyright (c) 2007-2009 Ariel Flesler - aflesler(at)gmail(dot)com | http://flesler.blogspot.com
|
||||||
|
* Dual licensed under MIT and GPL.
|
||||||
|
* Date: 3/11/2009
|
||||||
|
* @author Ariel Flesler
|
||||||
|
* @version 1.2.7
|
||||||
|
**/
|
||||||
|
;(function($){var l=location.href.replace(/#.*/,'');var g=$.localScroll=function(a){$('body').localScroll(a)};g.defaults={duration:1e3,axis:'y',event:'click',stop:true,target:window,reset:true};g.hash=function(a){if(location.hash){a=$.extend({},g.defaults,a);a.hash=false;if(a.reset){var e=a.duration;delete a.duration;$(a.target).scrollTo(0,a);a.duration=e}i(0,location,a)}};$.fn.localScroll=function(b){b=$.extend({},g.defaults,b);return b.lazy?this.bind(b.event,function(a){var e=$([a.target,a.target.parentNode]).filter(d)[0];if(e)i(a,e,b)}):this.find('a,area').filter(d).bind(b.event,function(a){i(a,this,b)}).end().end();function d(){return!!this.href&&!!this.hash&&this.href.replace(this.hash,'')==l&&(!b.filter||$(this).is(b.filter))}};function i(a,e,b){var d=e.hash.slice(1),f=document.getElementById(d)||document.getElementsByName(d)[0];if(!f)return;if(a)a.preventDefault();var h=$(b.target);if(b.lock&&h.is(':animated')||b.onBefore&&b.onBefore.call(b,a,f,h)===false)return;if(b.stop)h.stop(true);if(b.hash){var j=f.id==d?'id':'name',k=$('<a> </a>').attr(j,d).css({position:'absolute',top:$(window).scrollTop(),left:$(window).scrollLeft()});f[j]='';$('body').prepend(k);location=e.hash;k.remove();f[j]=d}h.scrollTo(f,b).trigger('notify.serialScroll',[f])}})(jQuery);
|
7
org-html-themes/src/bigblow_theme/js/jquery.scrollTo-1.4.3.1-min.js
vendored
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
/**
|
||||||
|
* Copyright (c) 2007-2012 Ariel Flesler - aflesler(at)gmail(dot)com | http://flesler.blogspot.com
|
||||||
|
* Dual licensed under MIT and GPL.
|
||||||
|
* @author Ariel Flesler
|
||||||
|
* @version 1.4.3.1
|
||||||
|
*/
|
||||||
|
;(function($){var h=$.scrollTo=function(a,b,c){$(window).scrollTo(a,b,c)};h.defaults={axis:'xy',duration:parseFloat($.fn.jquery)>=1.3?0:1,limit:true};h.window=function(a){return $(window)._scrollable()};$.fn._scrollable=function(){return this.map(function(){var a=this,isWin=!a.nodeName||$.inArray(a.nodeName.toLowerCase(),['iframe','#document','html','body'])!=-1;if(!isWin)return a;var b=(a.contentWindow||a).document||a.ownerDocument||a;return/webkit/i.test(navigator.userAgent)||b.compatMode=='BackCompat'?b.body:b.documentElement})};$.fn.scrollTo=function(e,f,g){if(typeof f=='object'){g=f;f=0}if(typeof g=='function')g={onAfter:g};if(e=='max')e=9e9;g=$.extend({},h.defaults,g);f=f||g.duration;g.queue=g.queue&&g.axis.length>1;if(g.queue)f/=2;g.offset=both(g.offset);g.over=both(g.over);return this._scrollable().each(function(){if(e==null)return;var d=this,$elem=$(d),targ=e,toff,attr={},win=$elem.is('html,body');switch(typeof targ){case'number':case'string':if(/^([+-]=)?\d+(\.\d+)?(px|%)?$/.test(targ)){targ=both(targ);break}targ=$(targ,this);if(!targ.length)return;case'object':if(targ.is||targ.style)toff=(targ=$(targ)).offset()}$.each(g.axis.split(''),function(i,a){var b=a=='x'?'Left':'Top',pos=b.toLowerCase(),key='scroll'+b,old=d[key],max=h.max(d,a);if(toff){attr[key]=toff[pos]+(win?0:old-$elem.offset()[pos]);if(g.margin){attr[key]-=parseInt(targ.css('margin'+b))||0;attr[key]-=parseInt(targ.css('border'+b+'Width'))||0}attr[key]+=g.offset[pos]||0;if(g.over[pos])attr[key]+=targ[a=='x'?'width':'height']()*g.over[pos]}else{var c=targ[pos];attr[key]=c.slice&&c.slice(-1)=='%'?parseFloat(c)/100*max:c}if(g.limit&&/^\d+$/.test(attr[key]))attr[key]=attr[key]<=0?0:Math.min(attr[key],max);if(!i&&g.queue){if(old!=attr[key])animate(g.onAfterFirst);delete attr[key]}});animate(g.onAfter);function animate(a){$elem.animate(attr,f,g.easing,a&&function(){a.call(this,e,g)})}}).end()};h.max=function(a,b){var c=b=='x'?'Width':'Height',scroll='scroll'+c;if(!$(a).is('html,body'))return a[scroll]-$(a)[c.toLowerCase()]();var d='client'+c,html=a.ownerDocument.documentElement,body=a.ownerDocument.body;return Math.max(html[scroll],body[scroll])-Math.min(html[d],body[d])};function both(a){return typeof a=='object'?a:{top:a,left:a}}})(jQuery);
|
12
org-html-themes/src/bigblow_theme/js/jquery.zclip.min.js
vendored
Normal file
21
org-html-themes/src/lib/js/bootstrap-license.txt
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright (c) 2011-2015 Twitter, Inc
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in
|
||||||
|
all copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||||
|
THE SOFTWARE.
|
7
org-html-themes/src/lib/js/bootstrap.min.js
vendored
Normal file
21
org-html-themes/src/lib/js/jquery-license.txt
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
Copyright 2014 jQuery Foundation and other contributors
|
||||||
|
http://jquery.com/
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining
|
||||||
|
a copy of this software and associated documentation files (the
|
||||||
|
"Software"), to deal in the Software without restriction, including
|
||||||
|
without limitation the rights to use, copy, modify, merge, publish,
|
||||||
|
distribute, sublicense, and/or sell copies of the Software, and to
|
||||||
|
permit persons to whom the Software is furnished to do so, subject to
|
||||||
|
the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be
|
||||||
|
included in all copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||||
|
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||||
|
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||||
|
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||||
|
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||||
|
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||||
|
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
4
org-html-themes/src/lib/js/jquery.min.js
vendored
Normal file
1
org-html-themes/src/lib/js/jquery.stickytableheaders.min.js
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
!function(a,b){"use strict";function c(c,g){var h=this;h.$el=a(c),h.el=c,h.id=e++,h.$window=a(b),h.$document=a(document),h.$el.bind("destroyed",a.proxy(h.teardown,h)),h.$clonedHeader=null,h.$originalHeader=null,h.isSticky=!1,h.hasBeenSticky=!1,h.leftOffset=null,h.topOffset=null,h.init=function(){h.$el.each(function(){var b=a(this);b.css("padding",0),h.$originalHeader=a("thead:first",this),h.$clonedHeader=h.$originalHeader.clone(),b.trigger("clonedHeader."+d,[h.$clonedHeader]),h.$clonedHeader.addClass("tableFloatingHeader"),h.$clonedHeader.css("display","none"),h.$originalHeader.addClass("tableFloatingHeaderOriginal"),h.$originalHeader.after(h.$clonedHeader),h.$printStyle=a('<style type="text/css" media="print">.tableFloatingHeader{display:none !important;}.tableFloatingHeaderOriginal{position:static !important;}</style>'),a("head").append(h.$printStyle)}),h.setOptions(g),h.updateWidth(),h.toggleHeaders(),h.bind()},h.destroy=function(){h.$el.unbind("destroyed",h.teardown),h.teardown()},h.teardown=function(){h.isSticky&&h.$originalHeader.css("position","static"),a.removeData(h.el,"plugin_"+d),h.unbind(),h.$clonedHeader.remove(),h.$originalHeader.removeClass("tableFloatingHeaderOriginal"),h.$originalHeader.css("visibility","visible"),h.$printStyle.remove(),h.el=null,h.$el=null},h.bind=function(){h.$scrollableArea.on("scroll."+d,h.toggleHeaders),h.isWindowScrolling||(h.$window.on("scroll."+d+h.id,h.setPositionValues),h.$window.on("resize."+d+h.id,h.toggleHeaders)),h.$scrollableArea.on("resize."+d,h.toggleHeaders),h.$scrollableArea.on("resize."+d,h.updateWidth)},h.unbind=function(){h.$scrollableArea.off("."+d,h.toggleHeaders),h.isWindowScrolling||(h.$window.off("."+d+h.id,h.setPositionValues),h.$window.off("."+d+h.id,h.toggleHeaders)),h.$scrollableArea.off("."+d,h.updateWidth)},h.toggleHeaders=function(){h.$el&&h.$el.each(function(){var b,c=a(this),d=h.isWindowScrolling?isNaN(h.options.fixedOffset)?h.options.fixedOffset.outerHeight():h.options.fixedOffset:h.$scrollableArea.offset().top+(isNaN(h.options.fixedOffset)?0:h.options.fixedOffset),e=c.offset(),f=h.$scrollableArea.scrollTop()+d,g=h.$scrollableArea.scrollLeft(),i=h.isWindowScrolling?f>e.top:d>e.top,j=(h.isWindowScrolling?f:0)<e.top+c.height()-h.$clonedHeader.height()-(h.isWindowScrolling?0:d);i&&j?(b=e.left-g+h.options.leftOffset,h.$originalHeader.css({position:"fixed","margin-top":h.options.marginTop,left:b,"z-index":3}),h.leftOffset=b,h.topOffset=d,h.$clonedHeader.css("display",""),h.isSticky||(h.isSticky=!0,h.updateWidth()),h.setPositionValues()):h.isSticky&&(h.$originalHeader.css("position","static"),h.$clonedHeader.css("display","none"),h.isSticky=!1,h.resetWidth(a("td,th",h.$clonedHeader),a("td,th",h.$originalHeader)))})},h.setPositionValues=function(){var a=h.$window.scrollTop(),b=h.$window.scrollLeft();!h.isSticky||0>a||a+h.$window.height()>h.$document.height()||0>b||b+h.$window.width()>h.$document.width()||h.$originalHeader.css({top:h.topOffset-(h.isWindowScrolling?0:a),left:h.leftOffset-(h.isWindowScrolling?0:b)})},h.updateWidth=function(){if(h.isSticky){h.$originalHeaderCells||(h.$originalHeaderCells=a("th,td",h.$originalHeader)),h.$clonedHeaderCells||(h.$clonedHeaderCells=a("th,td",h.$clonedHeader));var b=h.getWidth(h.$clonedHeaderCells);h.setWidth(b,h.$clonedHeaderCells,h.$originalHeaderCells),h.$originalHeader.css("width",h.$clonedHeader.width())}},h.getWidth=function(c){var d=[];return c.each(function(c){var e,f=a(this);if("border-box"===f.css("box-sizing"))e=f[0].getBoundingClientRect().width;else{var g=a("th",h.$originalHeader);if("collapse"===g.css("border-collapse"))if(b.getComputedStyle)e=parseFloat(b.getComputedStyle(this,null).width);else{var i=parseFloat(f.css("padding-left")),j=parseFloat(f.css("padding-right")),k=parseFloat(f.css("border-width"));e=f.outerWidth()-i-j-k}else e=f.width()}d[c]=e}),d},h.setWidth=function(a,b,c){b.each(function(b){var d=a[b];c.eq(b).css({"min-width":d,"max-width":d})})},h.resetWidth=function(b,c){b.each(function(b){var d=a(this);c.eq(b).css({"min-width":d.css("min-width"),"max-width":d.css("max-width")})})},h.setOptions=function(c){h.options=a.extend({},f,c),h.$scrollableArea=a(h.options.scrollableArea),h.isWindowScrolling=h.$scrollableArea[0]===b},h.updateOptions=function(a){h.setOptions(a),h.unbind(),h.bind(),h.updateWidth(),h.toggleHeaders()},h.init()}var d="stickyTableHeaders",e=0,f={fixedOffset:0,leftOffset:0,marginTop:0,scrollableArea:b};a.fn[d]=function(b){return this.each(function(){var e=a.data(this,"plugin_"+d);e?"string"==typeof b?e[b].apply(e):e.updateOptions(b):"destroy"!==b&&a.data(this,"plugin_"+d,new c(this,b))})}}(jQuery,window);
|
20
org-html-themes/src/lib/js/stickytableheaders-license.txt
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
Copyright (c) 2011 Jonas Mosbech
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining
|
||||||
|
a copy of this software and associated documentation files (the
|
||||||
|
"Software"), to deal in the Software without restriction, including
|
||||||
|
without limitation the rights to use, copy, modify, merge, publish,
|
||||||
|
distribute, sublicense, and/or sell copies of the Software, and to
|
||||||
|
permit persons to whom the Software is furnished to do so, subject to
|
||||||
|
the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be
|
||||||
|
included in all copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||||
|
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||||
|
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||||
|
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||||
|
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||||
|
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||||
|
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
145
org-html-themes/src/readtheorg_theme/css/htmlize.css
Normal file
@ -0,0 +1,145 @@
|
|||||||
|
.org-bold { /* bold */ font-weight: bold; }
|
||||||
|
.org-bold-italic { /* bold-italic */ font-weight: bold; font-style: italic; }
|
||||||
|
.org-buffer-menu-buffer { /* buffer-menu-buffer */ font-weight: bold; }
|
||||||
|
.org-builtin { /* font-lock-builtin-face */ color: #7a378b; }
|
||||||
|
.org-button { /* button */ text-decoration: underline; }
|
||||||
|
.org-calendar-today { /* calendar-today */ text-decoration: underline; }
|
||||||
|
.org-change-log-acknowledgement { /* change-log-acknowledgement */ color: #b22222; }
|
||||||
|
.org-change-log-conditionals { /* change-log-conditionals */ color: #a0522d; }
|
||||||
|
.org-change-log-date { /* change-log-date */ color: #8b2252; }
|
||||||
|
.org-change-log-email { /* change-log-email */ color: #a0522d; }
|
||||||
|
.org-change-log-file { /* change-log-file */ color: #0000ff; }
|
||||||
|
.org-change-log-function { /* change-log-function */ color: #a0522d; }
|
||||||
|
.org-change-log-list { /* change-log-list */ color: #a020f0; }
|
||||||
|
.org-change-log-name { /* change-log-name */ color: #008b8b; }
|
||||||
|
.org-comint-highlight-input { /* comint-highlight-input */ font-weight: bold; }
|
||||||
|
.org-comint-highlight-prompt { /* comint-highlight-prompt */ color: #00008b; }
|
||||||
|
.org-comment { /* font-lock-comment-face */ color: #999988; font-style: italic; }
|
||||||
|
.org-comment-delimiter { /* font-lock-comment-delimiter-face */ color: #999988; font-style: italic; }
|
||||||
|
.org-completions-annotations { /* completions-annotations */ font-style: italic; }
|
||||||
|
.org-completions-common-part { /* completions-common-part */ color: #000000; background-color: #ffffff; }
|
||||||
|
.org-completions-first-difference { /* completions-first-difference */ font-weight: bold; }
|
||||||
|
.org-constant { /* font-lock-constant-face */ color: #008b8b; }
|
||||||
|
.org-diary { /* diary */ color: #ff0000; }
|
||||||
|
.org-diff-context { /* diff-context */ color: #7f7f7f; }
|
||||||
|
.org-diff-file-header { /* diff-file-header */ background-color: #b3b3b3; font-weight: bold; }
|
||||||
|
.org-diff-function { /* diff-function */ background-color: #cccccc; }
|
||||||
|
.org-diff-header { /* diff-header */ background-color: #cccccc; }
|
||||||
|
.org-diff-hunk-header { /* diff-hunk-header */ background-color: #cccccc; }
|
||||||
|
.org-diff-index { /* diff-index */ background-color: #b3b3b3; font-weight: bold; }
|
||||||
|
.org-diff-nonexistent { /* diff-nonexistent */ background-color: #b3b3b3; font-weight: bold; }
|
||||||
|
.org-diff-refine-change { /* diff-refine-change */ background-color: #d9d9d9; }
|
||||||
|
.org-dired-directory { /* dired-directory */ color: #0000ff; }
|
||||||
|
.org-dired-flagged { /* dired-flagged */ color: #ff0000; font-weight: bold; }
|
||||||
|
.org-dired-header { /* dired-header */ color: #228b22; }
|
||||||
|
.org-dired-ignored { /* dired-ignored */ color: #7f7f7f; }
|
||||||
|
.org-dired-mark { /* dired-mark */ color: #008b8b; }
|
||||||
|
.org-dired-marked { /* dired-marked */ color: #ff0000; font-weight: bold; }
|
||||||
|
.org-dired-perm-write { /* dired-perm-write */ color: #b22222; }
|
||||||
|
.org-dired-symlink { /* dired-symlink */ color: #a020f0; }
|
||||||
|
.org-dired-warning { /* dired-warning */ color: #ff0000; font-weight: bold; }
|
||||||
|
.org-doc { /* font-lock-doc-face */ color: #8b2252; }
|
||||||
|
.org-escape-glyph { /* escape-glyph */ color: #a52a2a; }
|
||||||
|
.org-file-name-shadow { /* file-name-shadow */ color: #7f7f7f; }
|
||||||
|
.org-flyspell-duplicate { /* flyspell-duplicate */ color: #cdad00; font-weight: bold; text-decoration: underline; }
|
||||||
|
.org-flyspell-incorrect { /* flyspell-incorrect */ color: #ff4500; font-weight: bold; text-decoration: underline; }
|
||||||
|
.org-fringe { /* fringe */ background-color: #f2f2f2; }
|
||||||
|
.org-function-name { /* font-lock-function-name-face */ color: teal; }
|
||||||
|
.org-header-line { /* header-line */ color: #333333; background-color: #e5e5e5; }
|
||||||
|
.org-help-argument-name { /* help-argument-name */ font-style: italic; }
|
||||||
|
.org-highlight { /* highlight */ background-color: #b4eeb4; }
|
||||||
|
.org-holiday { /* holiday */ background-color: #ffc0cb; }
|
||||||
|
.org-isearch { /* isearch */ color: #b0e2ff; background-color: #cd00cd; }
|
||||||
|
.org-isearch-fail { /* isearch-fail */ background-color: #ffc1c1; }
|
||||||
|
.org-italic { /* italic */ font-style: italic; }
|
||||||
|
.org-keyword { /* font-lock-keyword-face */ color: #0086b3; }
|
||||||
|
.org-lazy-highlight { /* lazy-highlight */ background-color: #afeeee; }
|
||||||
|
.org-link { /* link */ color: #0000ff; text-decoration: underline; }
|
||||||
|
.org-link-visited { /* link-visited */ color: #8b008b; text-decoration: underline; }
|
||||||
|
.org-log-edit-header { /* log-edit-header */ color: #a020f0; }
|
||||||
|
.org-log-edit-summary { /* log-edit-summary */ color: #0000ff; }
|
||||||
|
.org-log-edit-unknown-header { /* log-edit-unknown-header */ color: #b22222; }
|
||||||
|
.org-match { /* match */ background-color: #ffff00; }
|
||||||
|
.org-next-error { /* next-error */ background-color: #eedc82; }
|
||||||
|
.org-nobreak-space { /* nobreak-space */ color: #a52a2a; text-decoration: underline; }
|
||||||
|
.org-org-archived { /* org-archived */ color: #7f7f7f; }
|
||||||
|
.org-org-block { /* org-block */ color: #7f7f7f; }
|
||||||
|
.org-org-block-begin-line { /* org-block-begin-line */ color: #b22222; }
|
||||||
|
.org-org-block-end-line { /* org-block-end-line */ color: #b22222; }
|
||||||
|
.org-org-checkbox { /* org-checkbox */ font-weight: bold; }
|
||||||
|
.org-org-checkbox-statistics-done { /* org-checkbox-statistics-done */ color: #228b22; font-weight: bold; }
|
||||||
|
.org-org-checkbox-statistics-todo { /* org-checkbox-statistics-todo */ color: #ff0000; font-weight: bold; }
|
||||||
|
.org-org-clock-overlay { /* org-clock-overlay */ background-color: #ffff00; }
|
||||||
|
.org-org-code { /* org-code */ color: #7f7f7f; }
|
||||||
|
.org-org-column { /* org-column */ background-color: #e5e5e5; }
|
||||||
|
.org-org-column-title { /* org-column-title */ background-color: #e5e5e5; font-weight: bold; text-decoration: underline; }
|
||||||
|
.org-org-date { /* org-date */ color: #a020f0; text-decoration: underline; }
|
||||||
|
.org-org-document-info { /* org-document-info */ color: #191970; }
|
||||||
|
.org-org-document-info-keyword { /* org-document-info-keyword */ color: #7f7f7f; }
|
||||||
|
.org-org-document-title { /* org-document-title */ color: #191970; font-size: 144%; font-weight: bold; }
|
||||||
|
.org-org-done { /* org-done */ color: #228b22; font-weight: bold; }
|
||||||
|
.org-org-drawer { /* org-drawer */ color: #0000ff; }
|
||||||
|
.org-org-ellipsis { /* org-ellipsis */ color: #b8860b; text-decoration: underline; }
|
||||||
|
.org-org-footnote { /* org-footnote */ color: #a020f0; text-decoration: underline; }
|
||||||
|
.org-org-formula { /* org-formula */ color: #b22222; }
|
||||||
|
.org-org-headline-done { /* org-headline-done */ color: #bc8f8f; }
|
||||||
|
.org-org-hide { /* org-hide */ color: #ffffff; }
|
||||||
|
.org-org-latex-and-export-specials { /* org-latex-and-export-specials */ color: #8b4513; }
|
||||||
|
.org-org-level-1 { /* org-level-1 */ color: #0000ff; }
|
||||||
|
.org-org-level-2 { /* org-level-2 */ color: #a0522d; }
|
||||||
|
.org-org-level-3 { /* org-level-3 */ color: #a020f0; }
|
||||||
|
.org-org-level-4 { /* org-level-4 */ color: #b22222; }
|
||||||
|
.org-org-level-5 { /* org-level-5 */ color: #228b22; }
|
||||||
|
.org-org-level-6 { /* org-level-6 */ color: #008b8b; }
|
||||||
|
.org-org-level-7 { /* org-level-7 */ color: #7a378b; }
|
||||||
|
.org-org-level-8 { /* org-level-8 */ color: #8b2252; }
|
||||||
|
.org-org-link { /* org-link */ color: #0000ff; text-decoration: underline; }
|
||||||
|
.org-org-meta-line { /* org-meta-line */ color: #b22222; }
|
||||||
|
.org-org-mode-line-clock { /* org-mode-line-clock */ color: #000000; background-color: #bfbfbf; }
|
||||||
|
.org-org-mode-line-clock-overrun { /* org-mode-line-clock-overrun */ color: #000000; background-color: #ff0000; }
|
||||||
|
.org-org-quote { /* org-quote */ color: #7f7f7f; }
|
||||||
|
.org-org-scheduled { /* org-scheduled */ color: #006400; }
|
||||||
|
.org-org-scheduled-previously { /* org-scheduled-previously */ color: #b22222; }
|
||||||
|
.org-org-scheduled-today { /* org-scheduled-today */ color: #006400; }
|
||||||
|
.org-org-sexp-date { /* org-sexp-date */ color: #a020f0; }
|
||||||
|
.org-org-special-keyword { /* org-special-keyword */ color: #a020f0; }
|
||||||
|
.org-org-table { /* org-table */ color: #0000ff; }
|
||||||
|
.org-org-tag { /* org-tag */ font-weight: bold; }
|
||||||
|
.org-org-target { /* org-target */ text-decoration: underline; }
|
||||||
|
.org-org-time-grid { /* org-time-grid */ color: #b8860b; }
|
||||||
|
.org-org-todo { /* org-todo */ color: #ff0000; font-weight: bold; }
|
||||||
|
.org-org-upcoming-deadline { /* org-upcoming-deadline */ color: #b22222; }
|
||||||
|
.org-org-verbatim { /* org-verbatim */ color: #7f7f7f; }
|
||||||
|
.org-org-verse { /* org-verse */ color: #7f7f7f; }
|
||||||
|
.org-org-warning { /* org-warning */ color: #ff0000; font-weight: bold; }
|
||||||
|
.org-outline-1 { /* outline-1 */ color: #0000ff; }
|
||||||
|
.org-outline-2 { /* outline-2 */ color: #a0522d; }
|
||||||
|
.org-outline-3 { /* outline-3 */ color: #a020f0; }
|
||||||
|
.org-outline-4 { /* outline-4 */ color: #b22222; }
|
||||||
|
.org-outline-5 { /* outline-5 */ color: #228b22; }
|
||||||
|
.org-outline-6 { /* outline-6 */ color: #008b8b; }
|
||||||
|
.org-outline-7 { /* outline-7 */ color: #7a378b; }
|
||||||
|
.org-outline-8 { /* outline-8 */ color: #8b2252; }
|
||||||
|
.org-preprocessor { /* font-lock-preprocessor-face */ color: #7a378b; }
|
||||||
|
.org-query-replace { /* query-replace */ color: #b0e2ff; background-color: #cd00cd; }
|
||||||
|
.org-regexp-grouping-backslash { /* font-lock-regexp-grouping-backslash */ font-weight: bold; }
|
||||||
|
.org-regexp-grouping-construct { /* font-lock-regexp-grouping-construct */ font-weight: bold; }
|
||||||
|
.org-region { /* region */ background-color: #eedc82; }
|
||||||
|
.org-secondary-selection { /* secondary-selection */ background-color: #ffff00; }
|
||||||
|
.org-shadow { /* shadow */ color: #7f7f7f; }
|
||||||
|
.org-show-paren-match { /* show-paren-match */ background-color: #40e0d0; }
|
||||||
|
.org-show-paren-mismatch { /* show-paren-mismatch */ color: #ffffff; background-color: #a020f0; }
|
||||||
|
.org-string { /* font-lock-string-face */ color: #dd1144; }
|
||||||
|
.org-tool-bar { /* tool-bar */ color: #000000; background-color: #bfbfbf; }
|
||||||
|
.org-tooltip { /* tooltip */ color: #000000; background-color: #ffffe0; }
|
||||||
|
.org-trailing-whitespace { /* trailing-whitespace */ background-color: #ff0000; }
|
||||||
|
.org-type { /* font-lock-type-face */ color: #228b22; }
|
||||||
|
.org-underline { /* underline */ text-decoration: underline; }
|
||||||
|
.org-variable-name { /* font-lock-variable-name-face */ color: teal; }
|
||||||
|
.org-warning { /* font-lock-warning-face */ color: #ff0000; font-weight: bold; }
|
||||||
|
.org-widget-button { /* widget-button */ font-weight: bold; }
|
||||||
|
.org-widget-button-pressed { /* widget-button-pressed */ color: #ff0000; }
|
||||||
|
.org-widget-documentation { /* widget-documentation */ color: #006400; }
|
||||||
|
.org-widget-field { /* widget-field */ background-color: #d9d9d9; }
|
||||||
|
.org-widget-inactive { /* widget-inactive */ color: #7f7f7f; }
|
||||||
|
.org-widget-single-line-field { /* widget-single-line-field */ background-color: #d9d9d9; }
|
1137
org-html-themes/src/readtheorg_theme/css/readtheorg.css
Normal file
3910
org-html-themes/src/readtheorg_theme/css/rtd-full.css
Normal file
105
org-html-themes/src/readtheorg_theme/js/readtheorg.js
Normal file
@ -0,0 +1,105 @@
|
|||||||
|
function collapse_toc_elements_on_click (nav_li_a){
|
||||||
|
/*
|
||||||
|
When an `a' element in the TOC is clicked, its parent
|
||||||
|
`li' element's active attribute is toggled. This causes
|
||||||
|
the element to toggle between minimized and maximized
|
||||||
|
states. The active attribute is documented in bootstrap.
|
||||||
|
https://getbootstrap.com/docs/4.0/components/navbar/#nav
|
||||||
|
*/
|
||||||
|
$(nav_li_el).parent().toggleClass("active");
|
||||||
|
}
|
||||||
|
|
||||||
|
$( document ).ready(function() {
|
||||||
|
// When the document is loaded and ready, bind the
|
||||||
|
// function `collapse_toc_elements_on_click' to the
|
||||||
|
// `a' elements in the table of contents.
|
||||||
|
$("#text-table-of-contents a").click(function() {
|
||||||
|
collapse_toc_elements_on_click(this);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
$(function() {
|
||||||
|
$('.note').before("<p class='admonition-title note'>Note</p>");
|
||||||
|
$('.seealso').before("<p class='admonition-title seealso'>See also</p>");
|
||||||
|
$('.warning').before("<p class='admonition-title warning'>Warning</p>");
|
||||||
|
$('.caution').before("<p class='admonition-title caution'>Caution</p>");
|
||||||
|
$('.attention').before("<p class='admonition-title attention'>Attention</p>");
|
||||||
|
$('.tip').before("<p class='admonition-title tip'>Tip</p>");
|
||||||
|
$('.important').before("<p class='admonition-title important'>Important</p>");
|
||||||
|
$('.hint').before("<p class='admonition-title hint'>Hint</p>");
|
||||||
|
$('.error').before("<p class='admonition-title error'>Error</p>");
|
||||||
|
$('.danger').before("<p class='admonition-title danger'>Danger</p>");
|
||||||
|
});
|
||||||
|
|
||||||
|
$( document ).ready(function() {
|
||||||
|
|
||||||
|
// Shift nav in mobile when clicking the menu.
|
||||||
|
$(document).on('click', "[data-toggle='wy-nav-top']", function() {
|
||||||
|
$("[data-toggle='wy-nav-shift']").toggleClass("shift");
|
||||||
|
$("[data-toggle='rst-versions']").toggleClass("shift");
|
||||||
|
});
|
||||||
|
// Close menu when you click a link.
|
||||||
|
$(document).on('click', ".wy-menu-vertical .current ul li a", function() {
|
||||||
|
$("[data-toggle='wy-nav-shift']").removeClass("shift");
|
||||||
|
$("[data-toggle='rst-versions']").toggleClass("shift");
|
||||||
|
});
|
||||||
|
$(document).on('click', "[data-toggle='rst-current-version']", function() {
|
||||||
|
$("[data-toggle='rst-versions']").toggleClass("shift-up");
|
||||||
|
});
|
||||||
|
// Make tables responsive
|
||||||
|
$("table.docutils:not(.field-list)").wrap("<div class='wy-table-responsive'></div>");
|
||||||
|
});
|
||||||
|
|
||||||
|
$( document ).ready(function() {
|
||||||
|
$('#text-table-of-contents ul').first().addClass('nav');
|
||||||
|
// ScrollSpy also requires that we use
|
||||||
|
// a Bootstrap nav component.
|
||||||
|
$('body').scrollspy({target: '#text-table-of-contents'});
|
||||||
|
|
||||||
|
// DON'T add sticky table headers (Fix issue #69?)
|
||||||
|
// $('table').stickyTableHeaders();
|
||||||
|
|
||||||
|
// set the height of tableOfContents
|
||||||
|
var $postamble = $('#postamble');
|
||||||
|
var $tableOfContents = $('#table-of-contents');
|
||||||
|
$tableOfContents.css({paddingBottom: $postamble.outerHeight()});
|
||||||
|
|
||||||
|
// add TOC button
|
||||||
|
var toggleSidebar = $('<div id="toggle-sidebar"><a href="#table-of-contents"><h2>Table of Contents</h2></a></div>');
|
||||||
|
$('#content').prepend(toggleSidebar);
|
||||||
|
|
||||||
|
// add close button when sidebar showed in mobile screen
|
||||||
|
var closeBtn = $('<a class="close-sidebar" href="#">Close</a>');
|
||||||
|
var tocTitle = $('#table-of-contents').find('h2');
|
||||||
|
tocTitle.append(closeBtn);
|
||||||
|
});
|
||||||
|
|
||||||
|
window.SphinxRtdTheme = (function (jquery) {
|
||||||
|
var stickyNav = (function () {
|
||||||
|
var navBar,
|
||||||
|
win,
|
||||||
|
stickyNavCssClass = 'stickynav',
|
||||||
|
applyStickNav = function () {
|
||||||
|
if (navBar.height() <= win.height()) {
|
||||||
|
navBar.addClass(stickyNavCssClass);
|
||||||
|
} else {
|
||||||
|
navBar.removeClass(stickyNavCssClass);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
enable = function () {
|
||||||
|
applyStickNav();
|
||||||
|
win.on('resize', applyStickNav);
|
||||||
|
},
|
||||||
|
init = function () {
|
||||||
|
navBar = jquery('nav.wy-nav-side:first');
|
||||||
|
win = jquery(window);
|
||||||
|
};
|
||||||
|
jquery(init);
|
||||||
|
return {
|
||||||
|
enable : enable
|
||||||
|
};
|
||||||
|
}());
|
||||||
|
return {
|
||||||
|
StickyNav : stickyNav
|
||||||
|
};
|
||||||
|
}($));
|
1520
org-html-themes/src/readtheorg_theme/readtheorg.org
Normal file
157
org-html-themes/tests/org-example.org
Normal file
@ -0,0 +1,157 @@
|
|||||||
|
# Hey Emacs, this is a -*- org -*- file ...
|
||||||
|
#+TITLE: Example of Tasks
|
||||||
|
#+AUTHOR: Fabrice Niessen
|
||||||
|
#+EMAIL: booster.emacs@gmail.com
|
||||||
|
#+LANGUAGE: en
|
||||||
|
#+OPTIONS: H:4 num:2 toc:4
|
||||||
|
|
||||||
|
#+SETUPFILE: ~/org/theme-readtheorg.setup
|
||||||
|
|
||||||
|
#+begin_export html
|
||||||
|
<div class="right">
|
||||||
|
<a href="https://github.com/fniessen/org-html-themes/blob/master/demo/example.org" class="fa fa-github"> Edit on GitHub</a>
|
||||||
|
</div>
|
||||||
|
#+end_export
|
||||||
|
|
||||||
|
-----
|
||||||
|
|
||||||
|
* Work :work:
|
||||||
|
:PROPERTIES:
|
||||||
|
:CATEGORY: Work
|
||||||
|
:END:
|
||||||
|
|
||||||
|
Only work tasks in this list.
|
||||||
|
|
||||||
|
** Marketing
|
||||||
|
:PROPERTIES:
|
||||||
|
:CATEGORY: Marketing
|
||||||
|
:END:
|
||||||
|
|
||||||
|
Project "Corporate Marketing".
|
||||||
|
|
||||||
|
*** Background and research
|
||||||
|
|
||||||
|
**** TODO Who are the competitors? :FLAGGED:
|
||||||
|
|
||||||
|
***** TODO What are our product's advantages?
|
||||||
|
|
||||||
|
***** TODO Target market
|
||||||
|
|
||||||
|
**** TODO Elevator pitch
|
||||||
|
|
||||||
|
*** PR firm
|
||||||
|
|
||||||
|
**** TODO Call Laura about PR firm :phone:
|
||||||
|
|
||||||
|
# *************** TODO Test with an inline task
|
||||||
|
# *************** END
|
||||||
|
|
||||||
|
**** STRT Interview PR firm candidates
|
||||||
|
DEADLINE: <2021-05-08 Sat>
|
||||||
|
:LOGBOOK:
|
||||||
|
CLOCK: [2013-02-05 Tue 09:00]--[2013-02-05 Tue 10:11] => 1:11
|
||||||
|
- State "TODO" -> "STRT" [2013-02-05 Tue 09:00]
|
||||||
|
:END:
|
||||||
|
|
||||||
|
# *************** TODO Another test with an inline task
|
||||||
|
|
||||||
|
*** Advertising campaign
|
||||||
|
|
||||||
|
**** TODO Call Joe
|
||||||
|
DEADLINE: <2021-05-06 Thu>
|
||||||
|
:PROPERTIES:
|
||||||
|
:Effort: 0:10
|
||||||
|
:END:
|
||||||
|
|
||||||
|
*** Plan conference
|
||||||
|
|
||||||
|
Calendar events/invitations.
|
||||||
|
|
||||||
|
**** TODO Recruit volunteers
|
||||||
|
DEADLINE: <2021-05-13 Thu>
|
||||||
|
|
||||||
|
**** TODO Make sure responses are coming back
|
||||||
|
|
||||||
|
** Operations
|
||||||
|
|
||||||
|
*** TODO Update database to latest version
|
||||||
|
SCHEDULED: <2021-04-13 Thu>
|
||||||
|
|
||||||
|
*** TODO Update Website
|
||||||
|
|
||||||
|
Update blog.
|
||||||
|
|
||||||
|
** Travel
|
||||||
|
|
||||||
|
*** Boston
|
||||||
|
|
||||||
|
**** TODO Find a flight
|
||||||
|
|
||||||
|
**** TODO Book hotel room
|
||||||
|
|
||||||
|
**** TODO Schedule meetings
|
||||||
|
|
||||||
|
**** TODO Submit expense report
|
||||||
|
|
||||||
|
-----
|
||||||
|
|
||||||
|
* Personal :personal:
|
||||||
|
:PROPERTIES:
|
||||||
|
:CATEGORY: Personal
|
||||||
|
:END:
|
||||||
|
|
||||||
|
** Reading
|
||||||
|
|
||||||
|
*** DONE Read "Getting Things Done"
|
||||||
|
:LOGBOOK:
|
||||||
|
- State "TODO" -> "DONE" [2021-02-06 Sat 15:10]
|
||||||
|
:END:
|
||||||
|
|
||||||
|
** Health
|
||||||
|
|
||||||
|
*** TODO Make dentist appointment :phone:
|
||||||
|
SCHEDULED: <2021-04-12 Wed>
|
||||||
|
|
||||||
|
*** TODO Go to the gym
|
||||||
|
SCHEDULED: <2021-04-11 Tue>
|
||||||
|
:PROPERTIES:
|
||||||
|
:Effort: 0:10
|
||||||
|
:END:
|
||||||
|
|
||||||
|
It should be as natural to some as showering or eating.
|
||||||
|
|
||||||
|
*** TODO Do jogging
|
||||||
|
|
||||||
|
Marathon = 42,195 km.
|
||||||
|
|
||||||
|
** Finance
|
||||||
|
|
||||||
|
*** TODO Pay electricity bill :FLAGGED:
|
||||||
|
|
||||||
|
*** TODO Renew newspaper subscription
|
||||||
|
|
||||||
|
*** TODO Cancel insurance :mail:
|
||||||
|
|
||||||
|
** Chores
|
||||||
|
|
||||||
|
*** TODO Buy milk
|
||||||
|
|
||||||
|
*** TODO Buy dog food
|
||||||
|
|
||||||
|
*** WAIT Mail package to Susan
|
||||||
|
|
||||||
|
*** TODO Buy groceries
|
||||||
|
|
||||||
|
*** TODO Mow the lawn
|
||||||
|
|
||||||
|
*** TODO Get a haircut
|
||||||
|
|
||||||
|
*** TODO Buy anniversary present
|
||||||
|
|
||||||
|
*** TODO Take out trash
|
||||||
|
|
||||||
|
*** TODO Get the car fixed
|
||||||
|
|
||||||
|
** Recreation
|
||||||
|
|
||||||
|
*** TODO Go to concert
|
853
org-html-themes/tests/org-mode-syntax-example.org
Normal file
@ -0,0 +1,853 @@
|
|||||||
|
# Hey Emacs, this is a -*- org -*- file ...
|
||||||
|
#+TITLE: Org mode syntax example
|
||||||
|
#+AUTHOR: Fabrice Niessen
|
||||||
|
#+EMAIL: fniessen@pirilampo.org
|
||||||
|
#+DESCRIPTION: Org mode syntax example
|
||||||
|
#+KEYWORDS: syntax, org, document
|
||||||
|
#+LANGUAGE: en
|
||||||
|
#+OPTIONS: H:5 num:nil toc:2 p:t
|
||||||
|
|
||||||
|
#+SETUPFILE: ~/org/theme-readtheorg.setup
|
||||||
|
|
||||||
|
#+PROPERTY: header-args :eval never-export
|
||||||
|
|
||||||
|
This is an Org mode document.
|
||||||
|
|
||||||
|
*Org mode* is a easy-to-write /plain text/ formatting syntax for authoring LaTeX
|
||||||
|
documents, creating Web pages and much more!
|
||||||
|
|
||||||
|
#+begin_html
|
||||||
|
<script src="http://platform.twitter.com/widgets.js"></script>
|
||||||
|
<a href="https://twitter.com/share" class="twitter-share-button" data-via="f_niessen">Tweet</a>
|
||||||
|
#+end_html
|
||||||
|
|
||||||
|
* Basics
|
||||||
|
|
||||||
|
** Biggest heading
|
||||||
|
|
||||||
|
New chapter.
|
||||||
|
|
||||||
|
*** Bigger heading
|
||||||
|
|
||||||
|
New section.
|
||||||
|
|
||||||
|
**** Big heading
|
||||||
|
|
||||||
|
New sub-section.
|
||||||
|
|
||||||
|
**** Text breaks
|
||||||
|
|
||||||
|
A single newline has no effect.
|
||||||
|
This line is part of the same paragraph.
|
||||||
|
|
||||||
|
But an empty line
|
||||||
|
|
||||||
|
demarcates paragraphs.
|
||||||
|
|
||||||
|
By entering two consecutive backslashes,
|
||||||
|
you can force to break lines \\
|
||||||
|
without starting a new paragraph.
|
||||||
|
|
||||||
|
For an horizontal line, insert at least 5 dashes: this is some text above an
|
||||||
|
horizontal rule
|
||||||
|
-----
|
||||||
|
and some text below it.
|
||||||
|
|
||||||
|
**** Numbered headings
|
||||||
|
|
||||||
|
You can create numbered headings up to a certain level by setting an option:
|
||||||
|
|
||||||
|
#+begin_src org
|
||||||
|
,#+OPTIONS: H:4
|
||||||
|
#+end_src
|
||||||
|
|
||||||
|
*** Text width
|
||||||
|
|
||||||
|
# Premiere Elements, page 111
|
||||||
|
#
|
||||||
|
# Vous pouvez créer ces objets en cliquant sur le bouton Nouvel| élément de le
|
||||||
|
# fenêtre Média. (Le Chapitre 14 explique comment créer| des titres ; le
|
||||||
|
# Chapitre 15 montre l'utilisation des barres et ton, de la| vidéo noir et de
|
||||||
|
# l'amorce SMPTE.)
|
||||||
|
#
|
||||||
|
# The principles of beautiful Web design, page 6
|
||||||
|
#
|
||||||
|
# In a figurative sense, the concept of visual balance is similar to that of
|
||||||
|
# physical balance| illustrated by a seesaw. Just as physical objects have
|
||||||
|
# weight, so do the elements of a layout.| If the elements on either side of a
|
||||||
|
# layout are of equal weight, they balance one another.| There are two main forms
|
||||||
|
# of visual balance: symmetrical and asymmetrical.
|
||||||
|
|
||||||
|
One morning, when Gregor Samsa woke from troubled dreams, he found himself
|
||||||
|
transformed in his bed into a horrible vermin. He lay on his armour-like back,
|
||||||
|
and if he lifted his head a little he could see his brown belly, slightly domed
|
||||||
|
and divided by arches into stiff sections. The bedding was hardly able to cover
|
||||||
|
it and seemed ready to slide off any moment. His many legs, pitifully thin
|
||||||
|
compared with the size of the rest of him, waved about helplessly as he looked.
|
||||||
|
|
||||||
|
** Lists
|
||||||
|
|
||||||
|
Org markup allows you to create bulleted or numbered lists. It allows any
|
||||||
|
combination of the two list types.
|
||||||
|
|
||||||
|
*** Unordered lists
|
||||||
|
|
||||||
|
Itemized lists are marked with bullets. They are convenient to:
|
||||||
|
|
||||||
|
- organize data, and
|
||||||
|
- make the document
|
||||||
|
+ prettier, and
|
||||||
|
+ easier to read.
|
||||||
|
|
||||||
|
Create them with a minus or a plus sign.
|
||||||
|
|
||||||
|
*** Ordered lists
|
||||||
|
|
||||||
|
Enumerated lists are marked with numbers or letters:
|
||||||
|
|
||||||
|
1. First element
|
||||||
|
1) First sub-item
|
||||||
|
2) Last sub-item
|
||||||
|
2. Second element
|
||||||
|
|
||||||
|
You can have ordered lists with jumping numbers:
|
||||||
|
|
||||||
|
1. [@1] First
|
||||||
|
2. [@2] Second
|
||||||
|
5. [@5] Jump to 5th
|
||||||
|
|
||||||
|
*** Definition lists
|
||||||
|
|
||||||
|
- Definition list ::
|
||||||
|
List containing definitions.
|
||||||
|
|
||||||
|
- Term to define ::
|
||||||
|
Explication of the term.
|
||||||
|
|
||||||
|
*** Checkboxes
|
||||||
|
- [ ] First item not checked
|
||||||
|
- [-] Second item half done
|
||||||
|
- [ ] Another first
|
||||||
|
- [ ] Another second
|
||||||
|
- [X] Third item checked
|
||||||
|
|
||||||
|
** Miscellaneous effects
|
||||||
|
|
||||||
|
*** Include Org files
|
||||||
|
|
||||||
|
You can include another Org file and skip its title by using the ~:lines~ argument
|
||||||
|
to ~#+INCLUDE~:
|
||||||
|
|
||||||
|
#+begin_src org
|
||||||
|
,#+INCLUDE: chapter1.org :lines "2-"
|
||||||
|
#+end_src
|
||||||
|
|
||||||
|
#+begin_note
|
||||||
|
File inclusion, through INCLUDE keywords, is an *export-only feature*.
|
||||||
|
#+end_note
|
||||||
|
|
||||||
|
*** Inline HTML
|
||||||
|
|
||||||
|
You can include raw HTML in your Org documents and it will get kept as HTML
|
||||||
|
when it's exported. XXX
|
||||||
|
|
||||||
|
#+HTML_BEGIN: <pre style="color:red">
|
||||||
|
Text can be preformatted (in a fixed-width font).
|
||||||
|
#+HTML_END: </pre>
|
||||||
|
|
||||||
|
It is especially useful for more advanced stuff like images or tables where you
|
||||||
|
need more control of the HTML options than Org mode actually gives you.
|
||||||
|
|
||||||
|
Similarly, you can incorporate JS or do anything else you can do in a Web page
|
||||||
|
(such as importing a CSS file).
|
||||||
|
|
||||||
|
You can create named classes (to get style control from your CSS) with:
|
||||||
|
|
||||||
|
#+begin_example
|
||||||
|
,#+begin_info
|
||||||
|
,*Info example* \\
|
||||||
|
Did you know...
|
||||||
|
,#+end_info
|
||||||
|
#+end_example
|
||||||
|
|
||||||
|
You can also add interactive elements to the HTML such as interactive R plots.
|
||||||
|
|
||||||
|
Finally, you can include an HTML file verbatim (during export) with:
|
||||||
|
|
||||||
|
#+begin_src org
|
||||||
|
,#+INCLUDE: file.html html
|
||||||
|
#+end_src
|
||||||
|
|
||||||
|
Don't edit the exported HTML file!
|
||||||
|
|
||||||
|
*** Inline LaTeX
|
||||||
|
|
||||||
|
You can also use raw LaTeX. XXX
|
||||||
|
|
||||||
|
#+LaTeX_BEGIN: \begin{verbatim}
|
||||||
|
Text can be preformatted (in a fixed-width font).
|
||||||
|
#+LaTeX_END: \end{verbatim}
|
||||||
|
|
||||||
|
*** Centered text
|
||||||
|
|
||||||
|
#+begin_center
|
||||||
|
This text is centered!
|
||||||
|
#+end_center
|
||||||
|
|
||||||
|
** Code blocks
|
||||||
|
|
||||||
|
*** COMMENT Syntax highlighting
|
||||||
|
|
||||||
|
The source code blocks support syntax highlighting:
|
||||||
|
|
||||||
|
#+begin_src cpp :eval no
|
||||||
|
/*
|
||||||
|
* Application that displays a "Hello" message to the standard output.
|
||||||
|
*/
|
||||||
|
int main(int arc, char **argv)
|
||||||
|
{
|
||||||
|
printf("Hello, %s!\n", (argc>1) ? argv[1] : "World");
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
#+end_src
|
||||||
|
|
||||||
|
The following language strings are currently recognized:
|
||||||
|
|
||||||
|
#+begin_src emacs-lisp :results drawer :exports results
|
||||||
|
(concat (mapconcat (lambda (widget)
|
||||||
|
(widget-get widget :tag))
|
||||||
|
(cl-remove-if-not (lambda (it)
|
||||||
|
(and (consp it)
|
||||||
|
(eq (car it) 'const)))
|
||||||
|
(cdr
|
||||||
|
(widget-get
|
||||||
|
(get
|
||||||
|
'org-babel-load-languages 'custom-type)
|
||||||
|
:key-type)))
|
||||||
|
", ")
|
||||||
|
".")
|
||||||
|
#+end_src
|
||||||
|
|
||||||
|
#+results:
|
||||||
|
:RESULTS:
|
||||||
|
Awk, C, R, Asymptote, Calc, Clojure, CSS, Ditaa, Dot, Emacs Lisp, Fortran, Gnuplot, Haskell, IO, J, Java, Javascript, LaTeX, Ledger, Lilypond, Lisp, Makefile, Maxima, Matlab, Mscgen, Ocaml, Octave, Org, Perl, Pico Lisp, PlantUML, Python, Ruby, Sass, Scala, Scheme, Screen, Shell Script, Shen, Sql, Sqlite, ebnf2ps.
|
||||||
|
:END:
|
||||||
|
|
||||||
|
Code block with long lines:
|
||||||
|
|
||||||
|
#+begin_src emacs-lisp :eval no
|
||||||
|
testing testing testing testing testing testing testing testing testing testing
|
||||||
|
0 1 2 3 4 5 6 7 8 9
|
||||||
|
123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456
|
||||||
|
#+end_src
|
||||||
|
|
||||||
|
For PDF (LaTeX), one solution is to surround the code block such as:
|
||||||
|
|
||||||
|
#+latex: \scriptsize
|
||||||
|
#+begin_src R
|
||||||
|
print("This block is in scriptsize")
|
||||||
|
#+end_src
|
||||||
|
#+latex: \normalize
|
||||||
|
|
||||||
|
*** Line numbers
|
||||||
|
|
||||||
|
Both in ~example~ and in ~src~ snippets, you can add a ~-n~ switch to the end of the
|
||||||
|
~begin~ line, to get the lines of the example numbered.
|
||||||
|
|
||||||
|
#+header: :eval no
|
||||||
|
#+begin_src emacs-lisp -n
|
||||||
|
(defun org-xor (a b)
|
||||||
|
"Exclusive or."
|
||||||
|
#+end_src
|
||||||
|
|
||||||
|
If you use a ~+n~ switch, the numbering from the previous numbered snippet will
|
||||||
|
be continued in the current one:
|
||||||
|
|
||||||
|
#+header: :eval no
|
||||||
|
#+begin_src emacs-lisp +n
|
||||||
|
(if a (not b) b))
|
||||||
|
#+end_src
|
||||||
|
|
||||||
|
In literal examples, Org will interpret strings like ~(ref:name)~ as labels, and
|
||||||
|
use them as targets for special hyperlinks like ~[[(name)]]~ (i.e., the reference
|
||||||
|
name enclosed in single parenthesis). In HTML, hovering the mouse over such
|
||||||
|
a link will remote-highlight the corresponding code line, which is kind of
|
||||||
|
cool.
|
||||||
|
|
||||||
|
You can also add a ~-r~ switch which removes the labels from the source code.
|
||||||
|
With the ~-n~ switch, links to these references will be labeled by the line
|
||||||
|
numbers from the code listing, otherwise links will use the labels with no
|
||||||
|
parentheses. Here is an example:
|
||||||
|
|
||||||
|
#+header: :eval no
|
||||||
|
#+begin_src emacs-lisp -n -r
|
||||||
|
(save-excursion ; (ref:sc)
|
||||||
|
(goto-char (point-min))) ; (ref:jump)
|
||||||
|
#+end_src
|
||||||
|
|
||||||
|
In line [[(sc)]], we remember the current position. [[(jump)][Line (jump)]] jumps to
|
||||||
|
~point-min~.
|
||||||
|
|
||||||
|
*** Output
|
||||||
|
|
||||||
|
The output from the *execution* of programs, scripts or commands can be inserted
|
||||||
|
in the document itself, allowing you to work in the /reproducible research/
|
||||||
|
mindset.
|
||||||
|
|
||||||
|
**** Text
|
||||||
|
|
||||||
|
A one-liner result:
|
||||||
|
|
||||||
|
#+begin_src sh :exports both :results verbatim
|
||||||
|
date +"%Y-%m-%d"
|
||||||
|
#+end_src
|
||||||
|
|
||||||
|
#+results:
|
||||||
|
: 2014-03-15
|
||||||
|
|
||||||
|
# A multiple-line result:
|
||||||
|
#
|
||||||
|
# #+name: list-of-styles
|
||||||
|
# #+begin_src sh :exports both :results verbatim
|
||||||
|
# # output all styles, but the default one (if any)
|
||||||
|
# ls styles | grep -v "default"
|
||||||
|
# #+end_src
|
||||||
|
#
|
||||||
|
# #+results: list-of-styles
|
||||||
|
# #+begin_example
|
||||||
|
# bigblow
|
||||||
|
# leuven
|
||||||
|
# maunakea
|
||||||
|
# #+end_example
|
||||||
|
|
||||||
|
**** Graphics
|
||||||
|
|
||||||
|
Data to be charted:
|
||||||
|
|
||||||
|
#+name: data
|
||||||
|
| Month | Degrees |
|
||||||
|
|-------+---------|
|
||||||
|
| 1 | 3.8 |
|
||||||
|
| 2 | 4.1 |
|
||||||
|
| 3 | 6.3 |
|
||||||
|
| 4 | 9.0 |
|
||||||
|
| 5 | 11.9 |
|
||||||
|
| 6 | 15.1 |
|
||||||
|
| 7 | 17.1 |
|
||||||
|
| 8 | 17.4 |
|
||||||
|
| 9 | 15.7 |
|
||||||
|
| 10 | 11.8 |
|
||||||
|
| 11 | 7.7 |
|
||||||
|
| 12 | 4.8 |
|
||||||
|
|
||||||
|
Code:
|
||||||
|
|
||||||
|
#+name: R-plot
|
||||||
|
#+begin_src R :var data=data :results graphics :file ../../images/Rplot.png :exports both
|
||||||
|
plot(data, type="b", bty="l", col=c("#ABD249"), las=1, lwd=4)
|
||||||
|
grid(nx=NULL, ny=NULL, col=c("#E8E8E8"), lwd=1)
|
||||||
|
legend("bottom", legend=c("Degrees"), col=c("#ABD249"), pch=c(19))
|
||||||
|
#+end_src
|
||||||
|
|
||||||
|
The resulting chart:
|
||||||
|
|
||||||
|
#+results: R-plot
|
||||||
|
[[file:../../images/Rplot.png]]
|
||||||
|
|
||||||
|
**** R code block
|
||||||
|
|
||||||
|
#+begin_src R
|
||||||
|
library(ggplot2)
|
||||||
|
summary(cars)
|
||||||
|
#+end_src
|
||||||
|
|
||||||
|
Plot:
|
||||||
|
|
||||||
|
#+begin_src R
|
||||||
|
library(ggplot2)
|
||||||
|
qplot(speed, dist, data = cars) + geom_smooth()
|
||||||
|
#+end_src
|
||||||
|
|
||||||
|
** Inline code
|
||||||
|
|
||||||
|
You can also evaluate code inline as follows: 1 + 1 is src_R{1 + 1}.
|
||||||
|
|
||||||
|
** Notes at the footer
|
||||||
|
|
||||||
|
It is possible to define named footnotes[fn:myfootnote], or ones with
|
||||||
|
automatic anchors[fn:2].
|
||||||
|
|
||||||
|
** Formatting text
|
||||||
|
|
||||||
|
*** Text effects
|
||||||
|
|
||||||
|
/Emphasize/ (italics), *strongly* (bold), and */very strongly/* (bold italics).
|
||||||
|
|
||||||
|
Markup elements could be nested: this is /italic text which contains
|
||||||
|
_underlined text_ within it/, whereas _this is normal underlined text_.
|
||||||
|
|
||||||
|
Markup can span across multiple lines, by default *no more than 2*:
|
||||||
|
|
||||||
|
*This
|
||||||
|
is not
|
||||||
|
bold*
|
||||||
|
|
||||||
|
Other elements to use sparingly are:
|
||||||
|
- monospaced typewriter font for ~inline code~
|
||||||
|
- monospaced typewriter font for =verbatim text=
|
||||||
|
- +deleted+ text (vs. _inserted_ text)
|
||||||
|
- text with^{superscript} (for example: ~m/s^{2}~ gives m/s^{2})
|
||||||
|
- text with_{subscript} (for example: ~H_{2}O~ gives H_{2}O)
|
||||||
|
|
||||||
|
*** Quotations
|
||||||
|
|
||||||
|
Use the ~quote~ block to typeset quoted text.
|
||||||
|
|
||||||
|
#+begin_quote
|
||||||
|
Let us change our traditional attitude to the construction of programs:
|
||||||
|
Instead of imagining that our main task is to instruct a computer what to do,
|
||||||
|
let us concentrate rather on explaining to human beings what we want a
|
||||||
|
computer to do.
|
||||||
|
|
||||||
|
The practitioner of literate programming can be regarded as an essayist, whose
|
||||||
|
main concern is with exposition and excellence of style. Such an author, with
|
||||||
|
thesaurus in hand, chooses the names of variables carefully and explains what
|
||||||
|
each variable means. He or she strives for a program that is comprehensible
|
||||||
|
because its concepts have been introduced in an order that is best for human
|
||||||
|
understanding, using a mixture of formal and informal methods that reinforce
|
||||||
|
each other.
|
||||||
|
|
||||||
|
--- Donald Knuth
|
||||||
|
#+end_quote
|
||||||
|
|
||||||
|
A short one:
|
||||||
|
|
||||||
|
#+begin_quote
|
||||||
|
Everything should be made as simple as possible,
|
||||||
|
but not any simpler -- Albert Einstein
|
||||||
|
#+end_quote
|
||||||
|
|
||||||
|
In a ~verse~ environment, there is an implicit line break at the end of each
|
||||||
|
line, and indentation and vertical space are preserved:
|
||||||
|
|
||||||
|
#+begin_verse
|
||||||
|
Everything should be made as simple as possible,
|
||||||
|
but not any simpler -- Albert Einstein
|
||||||
|
#+end_verse
|
||||||
|
|
||||||
|
Typically used for quoting passages of an email message:
|
||||||
|
|
||||||
|
#+begin_verse
|
||||||
|
>> This is an email message with "nested" quoting. Lorem ipsum dolor sit amet,
|
||||||
|
>> consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
|
||||||
|
>> Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
|
||||||
|
>
|
||||||
|
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse id sem
|
||||||
|
> consectetuer libero luctus adipiscing.
|
||||||
|
|
||||||
|
Itemized or unordered lists (~ul~):
|
||||||
|
- This is the first list item.
|
||||||
|
- This is the second list item.
|
||||||
|
|
||||||
|
Enumerated or ordered Lists (~ol~):
|
||||||
|
1. This is the first list item.
|
||||||
|
2. This is the second list item.
|
||||||
|
|
||||||
|
Maybe an equation here?
|
||||||
|
|
||||||
|
See http://www.google.com/ for more information...
|
||||||
|
#+end_verse
|
||||||
|
|
||||||
|
*** Spaces
|
||||||
|
|
||||||
|
Using non-breaking spaces.
|
||||||
|
|
||||||
|
Insert the Unicode character ~00A0~ to add a non-breaking space. FIXME
|
||||||
|
Or add/use an Org entity?
|
||||||
|
|
||||||
|
** Mathematical formulae
|
||||||
|
|
||||||
|
You can embed LaTeX math formatting in Org mode files using the following
|
||||||
|
syntax:
|
||||||
|
|
||||||
|
- For *inline math* expressions, use ~\(...\)~: \(x^2\) or \(1 < 2\).
|
||||||
|
|
||||||
|
It's /not/ advised to use the constructs ~$...$~ (both for Org and MathJax).
|
||||||
|
|
||||||
|
- Centered display equation (the /Euler theorem/):
|
||||||
|
|
||||||
|
\[
|
||||||
|
\int_0^\infty e^{-x^2} dx = {{\sqrt{\pi}} \over {2}}
|
||||||
|
\]
|
||||||
|
|
||||||
|
The use of ~\[...\]~ is for mathematical expressions which you want to make
|
||||||
|
*stand out, on their own lines*.
|
||||||
|
|
||||||
|
LaTeX allows to inline such ~\[...\]~ constructs (/quadratic formula/):
|
||||||
|
\[ \frac{-b \pm \sqrt{b^2 - 4 a c}}{2a} \]
|
||||||
|
|
||||||
|
*Double dollar signs (~$$~) should not be used*.
|
||||||
|
|
||||||
|
- The /sinus theorem/ can then be written as the equation:
|
||||||
|
|
||||||
|
\begin{equation}
|
||||||
|
\label{eqn:sinalpha}
|
||||||
|
\frac{\sin\alpha}{a}=\frac{\sin\beta}{b}
|
||||||
|
\end{equation}
|
||||||
|
|
||||||
|
- See Equation [[the-first]],
|
||||||
|
|
||||||
|
#+name: the-first
|
||||||
|
\begin{equation}
|
||||||
|
n_{i+1} = \frac{n_{i} (d-i) (e-1)}{(i+1)}
|
||||||
|
\end{equation}
|
||||||
|
|
||||||
|
Only captioned equations are numbered
|
||||||
|
|
||||||
|
- Other alternative: use \begin{equation*} or \begin{displaymath} (= the verbose
|
||||||
|
form of the ~\[...\]~ construct). M-q does not fill those.
|
||||||
|
|
||||||
|
Differently from $...$ and \(...\), an equation environment produces a *numbered*
|
||||||
|
equation to which you can add a label and reference the equation by (label)
|
||||||
|
name in other parts of the text. This is not possibly with unnumbered math
|
||||||
|
environments ($$, ...).
|
||||||
|
|
||||||
|
** Special characters
|
||||||
|
|
||||||
|
Some of the widely used special characters (converted from text characters to
|
||||||
|
their typographically correct entitites):
|
||||||
|
|
||||||
|
*** Accents
|
||||||
|
|
||||||
|
\Agrave \Aacute
|
||||||
|
|
||||||
|
*** Punctuation
|
||||||
|
|
||||||
|
Dash: \ndash \mdash
|
||||||
|
|
||||||
|
Marks: \iexcl \iquest
|
||||||
|
|
||||||
|
Quotations: \laquo \raquo
|
||||||
|
|
||||||
|
Miscellaneous: \para \ordf
|
||||||
|
|
||||||
|
*** Commercial symbols
|
||||||
|
|
||||||
|
Property marks: \copy \reg
|
||||||
|
|
||||||
|
Currency: \cent \EUR \yen \pound
|
||||||
|
|
||||||
|
*** Greek characters
|
||||||
|
|
||||||
|
The Greek letters \alpha, \beta, and \gamma are used to denote angles.
|
||||||
|
|
||||||
|
*** Math characters
|
||||||
|
|
||||||
|
Science: \pm \div
|
||||||
|
|
||||||
|
Arrows: \to \rarr \larr \harr \rArr \lArr \hArr
|
||||||
|
|
||||||
|
Function names: \arccos \cos
|
||||||
|
|
||||||
|
Signs and symbols: \bull \star
|
||||||
|
|
||||||
|
*** Misc
|
||||||
|
|
||||||
|
# Smilies: \smiley \sad
|
||||||
|
|
||||||
|
Suits: \clubs \spades
|
||||||
|
|
||||||
|
** Comments
|
||||||
|
|
||||||
|
It's possible to add comments in the document.
|
||||||
|
|
||||||
|
# This Org comment here won't be displayed.
|
||||||
|
|
||||||
|
** Tables
|
||||||
|
|
||||||
|
You can create tables with an optional header row (by using an horizontal line
|
||||||
|
of dashes to separate it from the rest of the table).
|
||||||
|
|
||||||
|
#+CAPTION: An example of table
|
||||||
|
| Header 1 | Header 2 | Header 3 |
|
||||||
|
|-------------+---------------+----------|
|
||||||
|
| Top left | Top middle | |
|
||||||
|
| | | Right |
|
||||||
|
| Bottom left | Bottom middle | |
|
||||||
|
|
||||||
|
Columns are automatically aligned:
|
||||||
|
|
||||||
|
- Number-rich columns to the right, and
|
||||||
|
- String-rich columns to the left.
|
||||||
|
|
||||||
|
If you want to override the automatic alignment, use ~<r>~, ~<c>~ or ~<l>~.
|
||||||
|
|
||||||
|
#+CAPTION: Table with alignment
|
||||||
|
| <r> | <c> | <l> |
|
||||||
|
| 1 | 2 | 3 |
|
||||||
|
| right | center | left |
|
||||||
|
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
|
||||||
|
|
||||||
|
Placement:
|
||||||
|
|
||||||
|
#+ATTR_LATEX: :center nil
|
||||||
|
| a | b |
|
||||||
|
| 1 | 2 |
|
||||||
|
|
||||||
|
XXX
|
||||||
|
Different from the following:
|
||||||
|
|
||||||
|
| a | b |
|
||||||
|
| 1 | 2 |
|
||||||
|
|
||||||
|
*** Align tables on the page
|
||||||
|
|
||||||
|
Here is a table on the left side:
|
||||||
|
|
||||||
|
#+LATEX: \noindent
|
||||||
|
#+ATTR_LATEX: :center nil
|
||||||
|
| a | b | c |
|
||||||
|
|---+---+---|
|
||||||
|
| 1 | 2 | 3 |
|
||||||
|
| 4 | 5 | 6 |
|
||||||
|
#+LATEX: \hfill
|
||||||
|
|
||||||
|
The noindent just gets rid of the indentation of the first line of a paragraph
|
||||||
|
which in this case is the table. The hfill adds infinite stretch after the
|
||||||
|
table, so it pushes the table to the left.
|
||||||
|
|
||||||
|
Here is a centered table:
|
||||||
|
|
||||||
|
| a | b | c |
|
||||||
|
|---+---+---|
|
||||||
|
| 1 | 2 | 3 |
|
||||||
|
| 4 | 5 | 6 |
|
||||||
|
|
||||||
|
And here's a table on the right side:
|
||||||
|
|
||||||
|
#+LATEX: \hfill
|
||||||
|
#+ATTR_LATEX: :center nil
|
||||||
|
| a | b | c |
|
||||||
|
|---+---+---|
|
||||||
|
| 1 | 2 | 3 |
|
||||||
|
| 4 | 5 | 6 |
|
||||||
|
|
||||||
|
Here the hfill adds infinite stretch before the table, so it pushes the table
|
||||||
|
to the right.
|
||||||
|
|
||||||
|
** Images, video and audio
|
||||||
|
|
||||||
|
*** Images
|
||||||
|
|
||||||
|
You can insert *image* files of different *formats* to a page:
|
||||||
|
|
||||||
|
| | HTML | PDF |
|
||||||
|
|------+------------------------------+-----|
|
||||||
|
| gif | yes | |
|
||||||
|
| jpeg | yes | |
|
||||||
|
| png | yes | |
|
||||||
|
| bmp | (depends on browser support) | |
|
||||||
|
|
||||||
|
In-line picture:
|
||||||
|
|
||||||
|
#+CAPTION: Org mode logo
|
||||||
|
#+ATTR_LaTeX: :width 0.25\linewidth
|
||||||
|
[[file:../../images/org-mode-unicorn.png]]
|
||||||
|
|
||||||
|
Direct link to just the [[file:org-mode-unicorn.png][Unicorn picture file]].
|
||||||
|
|
||||||
|
XXX Available HTML image tags include:
|
||||||
|
|
||||||
|
- align
|
||||||
|
- border
|
||||||
|
- bordercolor
|
||||||
|
- hspace
|
||||||
|
- vspace
|
||||||
|
- width
|
||||||
|
- height
|
||||||
|
- title
|
||||||
|
- alt
|
||||||
|
|
||||||
|
Place images side by side: XXX
|
||||||
|
|
||||||
|
*** Video
|
||||||
|
|
||||||
|
Videos can't be added directly but you can add an image with a link to the video like this:
|
||||||
|
|
||||||
|
[[http://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg][http://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE]]
|
||||||
|
|
||||||
|
*** Sounds
|
||||||
|
|
||||||
|
** Special text boxes
|
||||||
|
|
||||||
|
Simple box ("inline task"): XXX
|
||||||
|
|
||||||
|
# *************** TODO Do this task
|
||||||
|
# Description of inline task.
|
||||||
|
# *************** END
|
||||||
|
#
|
||||||
|
# or:
|
||||||
|
#
|
||||||
|
# *************** WAIT [#B] Do also this other task :phone:
|
||||||
|
# *************** END
|
||||||
|
|
||||||
|
*** Example
|
||||||
|
|
||||||
|
You can have ~example~ blocks.
|
||||||
|
|
||||||
|
Find entries with an *exact phrase* -- To do this, put the phrase in quotes:
|
||||||
|
|
||||||
|
: "hd ready"
|
||||||
|
|
||||||
|
You can create several other boxes (~info~, ~tip~, ~note~ or ~warning~) which all have
|
||||||
|
a different default image.
|
||||||
|
|
||||||
|
*** Info
|
||||||
|
|
||||||
|
An info box is displayed as follows:
|
||||||
|
|
||||||
|
#+begin_info
|
||||||
|
*Info example* \\
|
||||||
|
Did you know...
|
||||||
|
#+end_info
|
||||||
|
|
||||||
|
*** Tip
|
||||||
|
|
||||||
|
A tip box is displayed as follows:
|
||||||
|
|
||||||
|
#+begin_tip
|
||||||
|
*Tip example* \\
|
||||||
|
Try doing it this way...
|
||||||
|
#+end_tip
|
||||||
|
|
||||||
|
*** Note
|
||||||
|
|
||||||
|
A note box is displayed as follows:
|
||||||
|
|
||||||
|
#+begin_note
|
||||||
|
*Note example* \\
|
||||||
|
This is a useful note...
|
||||||
|
#+end_note
|
||||||
|
|
||||||
|
*** Warning
|
||||||
|
|
||||||
|
A warning box is displayed as follows:
|
||||||
|
|
||||||
|
#+begin_warning
|
||||||
|
*Warning example* \\
|
||||||
|
Be careful! Check that you have...
|
||||||
|
#+end_warning
|
||||||
|
|
||||||
|
** Links
|
||||||
|
:PROPERTIES:
|
||||||
|
:CUSTOM_ID: links
|
||||||
|
:END:
|
||||||
|
|
||||||
|
*** Anchors
|
||||||
|
:PROPERTIES:
|
||||||
|
:ID: 0d2b0cb2-116c-4a61-a076-4c641faf4346
|
||||||
|
:END:
|
||||||
|
|
||||||
|
Links generally point to an headline.
|
||||||
|
|
||||||
|
They can also point to a link anchor <<name-of-anchor-here>> in the current
|
||||||
|
document or in another document.
|
||||||
|
|
||||||
|
*** Hyperlinks
|
||||||
|
|
||||||
|
This document is available in [[file:example.txt][plain text]], [[file:example.html][HTML]] and [[file:example.pdf][PDF]].
|
||||||
|
|
||||||
|
The links are delimited by ~[square brackets]~.
|
||||||
|
|
||||||
|
**** Internal links
|
||||||
|
|
||||||
|
See:
|
||||||
|
- chapter [[#links][Links]]
|
||||||
|
- section [[id:0d2b0cb2-116c-4a61-a076-4c641faf4346][Anchors]]
|
||||||
|
- [[name-of-anchor-here][target in the document]]
|
||||||
|
|
||||||
|
**** External links
|
||||||
|
|
||||||
|
See the [[http://orgmode.org/][Org mode Web site]].
|
||||||
|
|
||||||
|
# Clicking on the image [[http://orgmode.org/][file:org-mode-unicorn.png]] leads to the Org mode home
|
||||||
|
# page.
|
||||||
|
|
||||||
|
[[mailto:concat.fni.at-sign.pirilampo.org][Mailto link]]
|
||||||
|
|
||||||
|
* Org miscellaneous
|
||||||
|
|
||||||
|
** Dates
|
||||||
|
|
||||||
|
Timestamps: [2014-01-16 Thu] and <2014-01-16 Thu>.
|
||||||
|
|
||||||
|
** DONE [#A] Buy GTD book :online:
|
||||||
|
:LOGBOOK:
|
||||||
|
- State "TODO" -> "DONE" [2014-01-16 Thu 09:52]
|
||||||
|
:END:
|
||||||
|
|
||||||
|
By default, ~DONE~ actions will be collapsed.
|
||||||
|
|
||||||
|
Note that I should probably implement that default behavior only for ~ARCHIVE~'d
|
||||||
|
items.
|
||||||
|
|
||||||
|
** TODO [#A] Read GTD book
|
||||||
|
SCHEDULED: <2014-09-11 Thu>
|
||||||
|
|
||||||
|
By default, *all* (active) entries will be expanded at page load, so that their
|
||||||
|
contents is visible.
|
||||||
|
|
||||||
|
That can be changed by adding such a line (into your Org document):
|
||||||
|
|
||||||
|
#+begin_src org
|
||||||
|
,#+HTML_HEAD: <script> var HS_STARTUP_FOLDED = true; </script>
|
||||||
|
#+end_src
|
||||||
|
|
||||||
|
** TODO [#B] Apply GTD methodoloy
|
||||||
|
DEADLINE: <2014-12-01 Mon>
|
||||||
|
:PROPERTIES:
|
||||||
|
:HTML_CONTAINER_CLASS: hsCollapsed
|
||||||
|
:END:
|
||||||
|
|
||||||
|
This section will be collapsed when loading the page because the entry has the
|
||||||
|
value ~hsCollapsed~ for the property ~:HTML_CONTAINER_CLASS:~.
|
||||||
|
|
||||||
|
Powerful, no?
|
||||||
|
|
||||||
|
** Some note :computer:write:
|
||||||
|
|
||||||
|
You can add tags to any entry, and hightlight all entries having some specific
|
||||||
|
tag by clicking on the buttons made accessible to you in the "Dashboard".
|
||||||
|
|
||||||
|
** Weekly review :computer:
|
||||||
|
|
||||||
|
Now, you can even make your weekly review in the HTML export... Press the ~r~ key
|
||||||
|
to start entering the "review mode" where all but one active entry are
|
||||||
|
collapsed, so that you can really focus on one item at a time!
|
||||||
|
|
||||||
|
* Org macros
|
||||||
|
|
||||||
|
#+MACRO: color @@html:<span style="color: $1">$2</span>@@
|
||||||
|
|
||||||
|
{{{color(blue, This text is colored in blue.)}}}
|
||||||
|
|
||||||
|
{{{color(red, This other text is in red.)}}}
|
||||||
|
|
||||||
|
Find more macros on [[https://github.com/fniessen/org-macros][GitHub]].
|
||||||
|
|
||||||
|
* BigBlow addons
|
||||||
|
|
||||||
|
The string ~fixme~ (in *upper case*) gets replaced by a "Fix Me!" image:
|
||||||
|
|
||||||
|
FIXME Delete this...
|
||||||
|
|
||||||
|
* Footnotes
|
||||||
|
|
||||||
|
[fn:myfootnote] Extensively used in large documents.
|
||||||
|
|
||||||
|
[fn:2] Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
|
||||||
|
eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim
|
||||||
|
veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
|
||||||
|
commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit
|
||||||
|
esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat
|
||||||
|
non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
123
org-html-themes/tests/org-theme-chooser.org
Normal file
@ -0,0 +1,123 @@
|
|||||||
|
# Hey Emacs, this is a -*- org -*- file ...
|
||||||
|
#+TITLE: Theme Chooser
|
||||||
|
#+AUTHOR: Fabrice Niessen
|
||||||
|
#+EMAIL: (concat "fniessen" at-sign "pirilampo.org")
|
||||||
|
#+LANGUAGE: en
|
||||||
|
#+OPTIONS: H:6 num:nil toc:4
|
||||||
|
|
||||||
|
#+SETUPFILE: ~/org/theme-readtheorg.setup
|
||||||
|
|
||||||
|
# See GitHub Settings > GitHub Pages > Theme Chooser
|
||||||
|
|
||||||
|
Text can be *bold*, /italic/, or +strikethrough+.
|
||||||
|
|
||||||
|
[[https://github.com/fniessen/org-html-themes/org/theme-chooser.htmltheme-chooser.txt][Link to another page.]]
|
||||||
|
|
||||||
|
There should be whitespace between paragraphs.
|
||||||
|
|
||||||
|
There should be whitespace between paragraphs. We recommend including a README,
|
||||||
|
or a file with information about your project.
|
||||||
|
|
||||||
|
* Header 1
|
||||||
|
|
||||||
|
This is a normal paragraph following a header. GitHub is a code hosting platform
|
||||||
|
for version control and collaboration. It lets you and others work together on
|
||||||
|
projects from anywhere.
|
||||||
|
|
||||||
|
** Header 2
|
||||||
|
|
||||||
|
This is a blockquote following a header.
|
||||||
|
|
||||||
|
When something is important enough, you do it even if the odds are not in your
|
||||||
|
favor.
|
||||||
|
|
||||||
|
*** Header 3
|
||||||
|
|
||||||
|
#+begin_src javascript
|
||||||
|
// Javascript code with syntax highlighting.
|
||||||
|
var fun = function lang(l) {
|
||||||
|
dateformat.i18n = require('./lang/' + l)
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
#+end_src
|
||||||
|
|
||||||
|
#+begin_src ruby
|
||||||
|
# Ruby code with syntax highlighting
|
||||||
|
GitHubPages::Dependencies.gems.each do |gem, version|
|
||||||
|
s.add_dependency(gem, "= #{version}")
|
||||||
|
end
|
||||||
|
#+end_src
|
||||||
|
|
||||||
|
**** Header 4
|
||||||
|
|
||||||
|
- This is an unordered list following a header.
|
||||||
|
- This is an unordered list following a header.
|
||||||
|
- This is an unordered list following a header.
|
||||||
|
|
||||||
|
***** Header 5
|
||||||
|
|
||||||
|
1. This is an ordered list following a header.
|
||||||
|
2. This is an ordered list following a header.
|
||||||
|
3. This is an ordered list following a header.
|
||||||
|
|
||||||
|
****** Header 6
|
||||||
|
|
||||||
|
| head1 | head two | three |
|
||||||
|
|--------------+-------------------+-------|
|
||||||
|
| ok | good swedish fish | nice |
|
||||||
|
| out of stock | good and plenty | nice |
|
||||||
|
| ok | good ~oreos~ | hmm |
|
||||||
|
| ok | good =zoute= drop | yumm |
|
||||||
|
|
||||||
|
*** There's a horizontal rule below this.
|
||||||
|
|
||||||
|
-----
|
||||||
|
|
||||||
|
*** Here is an unordered list:
|
||||||
|
|
||||||
|
- Item foo
|
||||||
|
- Item bar
|
||||||
|
- Item baz
|
||||||
|
- Item zip
|
||||||
|
|
||||||
|
*** And an ordered list:
|
||||||
|
|
||||||
|
1. Item one
|
||||||
|
2. Item two
|
||||||
|
3. Item three
|
||||||
|
4. Item four
|
||||||
|
|
||||||
|
*** And a nested list:
|
||||||
|
|
||||||
|
- level 1 item
|
||||||
|
+ level 2 item
|
||||||
|
+ level 2 item
|
||||||
|
* level 3 item
|
||||||
|
* level 3 item
|
||||||
|
- level 1 item
|
||||||
|
+ level 2 item
|
||||||
|
+ level 2 item
|
||||||
|
+ level 2 item
|
||||||
|
- level 1 item
|
||||||
|
+ level 2 item
|
||||||
|
+ level 2 item
|
||||||
|
- level 1 item
|
||||||
|
|
||||||
|
*** Small image
|
||||||
|
|
||||||
|
Octocat
|
||||||
|
|
||||||
|
*** Large image
|
||||||
|
|
||||||
|
Branching
|
||||||
|
|
||||||
|
*** Definition lists can be used with HTML syntax.
|
||||||
|
|
||||||
|
- Name :: Godzilla
|
||||||
|
- Born :: 1952
|
||||||
|
- Birthplace :: Japan
|
||||||
|
- Color :: Green
|
||||||
|
|
||||||
|
: Long, single-line code blocks should not wrap. They should horizontally scroll if they are too long. This line should be long enough to demonstrate this.
|
||||||
|
|
||||||
|
: The final element.
|
@ -3,7 +3,7 @@
|
|||||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
||||||
<head>
|
<head>
|
||||||
<!-- 2021-09-24 Fri 08:06 -->
|
<!-- 2021-09-24 Fri 10:10 -->
|
||||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||||
<title>Front end API</title>
|
<title>Front end API</title>
|
||||||
@ -180,6 +180,12 @@
|
|||||||
.org-svg { width: 90%; }
|
.org-svg { width: 90%; }
|
||||||
/*]]>*/-->
|
/*]]>*/-->
|
||||||
</style>
|
</style>
|
||||||
|
<link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/css/htmlize.css"/>
|
||||||
|
<link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/css/readtheorg.css"/>
|
||||||
|
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
|
||||||
|
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
|
||||||
|
<script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/lib/js/jquery.stickytableheaders.min.js"></script>
|
||||||
|
<script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/js/readtheorg.js"></script>
|
||||||
<link rel="stylesheet" title="Standard" href="trexio.css" type="text/css" />
|
<link rel="stylesheet" title="Standard" href="trexio.css" type="text/css" />
|
||||||
|
|
||||||
<script type="text/javascript" src="org-info.js">
|
<script type="text/javascript" src="org-info.js">
|
||||||
@ -333,125 +339,125 @@ for the JavaScript code in this tag.
|
|||||||
<h2>Table of Contents</h2>
|
<h2>Table of Contents</h2>
|
||||||
<div id="text-table-of-contents">
|
<div id="text-table-of-contents">
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#orge6d40ef">1. Coding conventions</a>
|
<li><a href="#org8333c1d">1. Coding conventions</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org8cf9921">1.1. Memory allocation</a></li>
|
<li><a href="#org86411e7">1.1. Memory allocation</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#orgeb174aa">2. Front end</a>
|
<li><a href="#orgfaa6909">2. Front end</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#orgf2e5d0b">2.1. Error handling</a>
|
<li><a href="#org500c687">2.1. Error handling</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org5e02bcb">2.1.1. Decoding errors</a>
|
<li><a href="#org33d43d5">2.1.1. Decoding errors</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org0baf5b4">2.1.1.1. C source code</a></li>
|
<li><a href="#org5790b7d">2.1.1.1. C source code</a></li>
|
||||||
<li><a href="#orgf31c3ed">2.1.1.2. Fortran interface</a></li>
|
<li><a href="#org2e427fd">2.1.1.2. Fortran interface</a></li>
|
||||||
<li><a href="#org3513a5d">2.1.1.3. Python interface</a></li>
|
<li><a href="#orgc234861">2.1.1.3. Python interface</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#org3ee4132">2.2. Back ends</a>
|
<li><a href="#org72c0c90">2.2. Back ends</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org2564d42">2.2.1. C</a></li>
|
<li><a href="#orga37141f">2.2.1. C</a></li>
|
||||||
<li><a href="#org0c3c8dc">2.2.2. Fortran</a></li>
|
<li><a href="#org6ed185d">2.2.2. Fortran</a></li>
|
||||||
<li><a href="#orga8769dd">2.2.3. Python</a></li>
|
<li><a href="#org98c597b">2.2.3. Python</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#org8dd8923">2.3. Read/write behavior</a></li>
|
<li><a href="#org0c779da">2.3. Read/write behavior</a></li>
|
||||||
<li><a href="#orgb1fbb47">2.4. TREXIO file type</a>
|
<li><a href="#orga0ee255">2.4. TREXIO file type</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#orgc076d8d">2.4.1. TREXIO<sub>File</sub> Python class</a></li>
|
<li><a href="#orgd59c29e">2.4.1. TREXIO<sub>File</sub> Python class</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#orga1927ad">2.5. Polymorphism of the file handle</a></li>
|
<li><a href="#org24d23e9">2.5. Polymorphism of the file handle</a></li>
|
||||||
<li><a href="#org0511c45">2.6. File opening</a>
|
<li><a href="#orge917409">2.6. File opening</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org38996c9">2.6.1. C</a></li>
|
<li><a href="#org416f068">2.6.1. C</a></li>
|
||||||
<li><a href="#org2d577fa">2.6.2. Fortran</a></li>
|
<li><a href="#org44ce5c3">2.6.2. Fortran</a></li>
|
||||||
<li><a href="#orgc308b03">2.6.3. Python</a></li>
|
<li><a href="#orgfbcedfc">2.6.3. Python</a></li>
|
||||||
<li><a href="#orgfda21b7">2.6.4. Zero-based versus one-based arrays of indices</a></li>
|
<li><a href="#org67ab986">2.6.4. Zero-based versus one-based arrays of indices</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#org8b08843">2.7. File closing</a>
|
<li><a href="#org4a50e2f">2.7. File closing</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#orga595c51">2.7.1. C</a></li>
|
<li><a href="#org47cf699">2.7.1. C</a></li>
|
||||||
<li><a href="#orge6a8363">2.7.2. Fortran</a></li>
|
<li><a href="#org76b3ace">2.7.2. Fortran</a></li>
|
||||||
<li><a href="#org6d2eb9c">2.7.3. Python</a></li>
|
<li><a href="#orgb20ec13">2.7.3. Python</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#org8a6d057">3. Templates for front end</a>
|
<li><a href="#orgb6c5610">3. Templates for front end</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org5d42594">3.1. Description</a></li>
|
<li><a href="#orgfd46f6b">3.1. Description</a></li>
|
||||||
<li><a href="#org900dc86">3.2. Templates for front end has/read/write a single numerical attribute</a>
|
<li><a href="#orgf5b0ec7">3.2. Templates for front end has/read/write a single numerical attribute</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org31c29c0">3.2.1. Introduction</a></li>
|
<li><a href="#org208fee4">3.2.1. Introduction</a></li>
|
||||||
<li><a href="#orgcd1853f">3.2.2. C templates for front end</a>
|
<li><a href="#org2365b3e">3.2.2. C templates for front end</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org47302c2">3.2.2.1. Function declarations</a></li>
|
<li><a href="#org6b47a3b">3.2.2.1. Function declarations</a></li>
|
||||||
<li><a href="#org6f70115">3.2.2.2. Source code for double precision functions</a></li>
|
<li><a href="#org237c62c">3.2.2.2. Source code for double precision functions</a></li>
|
||||||
<li><a href="#org9736201">3.2.2.3. Source code for single precision functions</a></li>
|
<li><a href="#org999d6c3">3.2.2.3. Source code for single precision functions</a></li>
|
||||||
<li><a href="#orge8285a0">3.2.2.4. Source code for default functions</a></li>
|
<li><a href="#org26d8210">3.2.2.4. Source code for default functions</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#orga65cca9">3.2.3. Fortran templates for front end</a></li>
|
<li><a href="#orgf2cbdf2">3.2.3. Fortran templates for front end</a></li>
|
||||||
<li><a href="#org1922bc8">3.2.4. Python templates for front end</a></li>
|
<li><a href="#orge5872bb">3.2.4. Python templates for front end</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#org27c1425">3.3. Templates for front end has/read/write a dataset of numerical data</a>
|
<li><a href="#orgd2ea031">3.3. Templates for front end has/read/write a dataset of numerical data</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#orgcc0595b">3.3.1. Introduction</a></li>
|
<li><a href="#orgee0739a">3.3.1. Introduction</a></li>
|
||||||
<li><a href="#org12b314d">3.3.2. C templates for front end</a>
|
<li><a href="#orgdc30ab3">3.3.2. C templates for front end</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org3103bae">3.3.2.1. Function declarations</a></li>
|
<li><a href="#org201267c">3.3.2.1. Function declarations</a></li>
|
||||||
<li><a href="#org0a8782e">3.3.2.2. Source code for double precision functions</a></li>
|
<li><a href="#org7f2264b">3.3.2.2. Source code for double precision functions</a></li>
|
||||||
<li><a href="#orga67b9d2">3.3.2.3. Source code for single precision functions</a></li>
|
<li><a href="#org3eb7e15">3.3.2.3. Source code for single precision functions</a></li>
|
||||||
<li><a href="#orgfc20175">3.3.2.4. Source code for memory-safe functions</a></li>
|
<li><a href="#org0486967">3.3.2.4. Source code for memory-safe functions</a></li>
|
||||||
<li><a href="#orgeeb11da">3.3.2.5. Source code for default functions</a></li>
|
<li><a href="#orgbc3f092">3.3.2.5. Source code for default functions</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#org8c31373">3.3.3. Fortran templates for front end</a></li>
|
<li><a href="#org1f61d7e">3.3.3. Fortran templates for front end</a></li>
|
||||||
<li><a href="#org24588f5">3.3.4. Python templates for front end</a></li>
|
<li><a href="#orge2bfe6a">3.3.4. Python templates for front end</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#org56044bb">3.4. Sparse data structures</a></li>
|
<li><a href="#org659f3c1">3.4. Sparse data structures</a></li>
|
||||||
<li><a href="#org2680da5">3.5. Templates for front end has/read/write a dataset of strings</a>
|
<li><a href="#org87def1b">3.5. Templates for front end has/read/write a dataset of strings</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#orga75618f">3.5.1. Introduction</a></li>
|
<li><a href="#orgb0a00cb">3.5.1. Introduction</a></li>
|
||||||
<li><a href="#orgdcac756">3.5.2. C templates for front end</a>
|
<li><a href="#org3488fe4">3.5.2. C templates for front end</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org3498d98">3.5.2.1. Function declarations</a></li>
|
<li><a href="#org47e3782">3.5.2.1. Function declarations</a></li>
|
||||||
<li><a href="#orgd879998">3.5.2.2. Source code for default functions</a></li>
|
<li><a href="#orge7a31a7">3.5.2.2. Source code for default functions</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#org99028fc">3.5.3. Fortran templates for front end</a></li>
|
<li><a href="#orgeb16281">3.5.3. Fortran templates for front end</a></li>
|
||||||
<li><a href="#orgf37abe7">3.5.4. Python templates for front end</a></li>
|
<li><a href="#org4d12235">3.5.4. Python templates for front end</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#orgb6b5769">3.6. Templates for front end has/read/write a single string attribute</a>
|
<li><a href="#orge4feb79">3.6. Templates for front end has/read/write a single string attribute</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org670a0e2">3.6.1. Introduction</a></li>
|
<li><a href="#orgc77a321">3.6.1. Introduction</a></li>
|
||||||
<li><a href="#org3b19988">3.6.2. C templates for front end</a>
|
<li><a href="#orgf7b8294">3.6.2. C templates for front end</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org055066b">3.6.2.1. Function declarations</a></li>
|
<li><a href="#org14f3700">3.6.2.1. Function declarations</a></li>
|
||||||
<li><a href="#orgbfabf62">3.6.2.2. Source code for default functions</a></li>
|
<li><a href="#orgd07b730">3.6.2.2. Source code for default functions</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#org2fe674d">3.6.3. Fortran templates for front end</a></li>
|
<li><a href="#org862805e">3.6.3. Fortran templates for front end</a></li>
|
||||||
<li><a href="#org0010428">3.6.4. Python templates for front end</a></li>
|
<li><a href="#org2d66187">3.6.4. Python templates for front end</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#org979abdb">4. Fortran helper/wrapper functions</a></li>
|
<li><a href="#orgbfd4c79">4. Fortran helper/wrapper functions</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orge6d40ef" class="outline-2">
|
<div id="outline-container-org8333c1d" class="outline-2">
|
||||||
<h2 id="orge6d40ef"><span class="section-number-2">1</span> Coding conventions</h2>
|
<h2 id="org8333c1d"><span class="section-number-2">1</span> Coding conventions</h2>
|
||||||
<div class="outline-text-2" id="text-1">
|
<div class="outline-text-2" id="text-1">
|
||||||
<ul class="org-ul">
|
<ul class="org-ul">
|
||||||
<li>integer types will be defined using types given in <code>stdint.h</code></li>
|
<li>integer types will be defined using types given in <code>stdint.h</code></li>
|
||||||
@ -466,8 +472,8 @@ for the JavaScript code in this tag.
|
|||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org8cf9921" class="outline-3">
|
<div id="outline-container-org86411e7" class="outline-3">
|
||||||
<h3 id="org8cf9921"><span class="section-number-3">1.1</span> Memory allocation</h3>
|
<h3 id="org86411e7"><span class="section-number-3">1.1</span> Memory allocation</h3>
|
||||||
<div class="outline-text-3" id="text-1-1">
|
<div class="outline-text-3" id="text-1-1">
|
||||||
<p>
|
<p>
|
||||||
Memory allocation of structures can be facilitated by using the
|
Memory allocation of structures can be facilitated by using the
|
||||||
@ -502,8 +508,8 @@ The maximum string size for the filenames is 4096 characters.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgeb174aa" class="outline-2">
|
<div id="outline-container-orgfaa6909" class="outline-2">
|
||||||
<h2 id="orgeb174aa"><span class="section-number-2">2</span> Front end</h2>
|
<h2 id="orgfaa6909"><span class="section-number-2">2</span> Front end</h2>
|
||||||
<div class="outline-text-2" id="text-2">
|
<div class="outline-text-2" id="text-2">
|
||||||
<p>
|
<p>
|
||||||
All calls to TREXIO are thread-safe.
|
All calls to TREXIO are thread-safe.
|
||||||
@ -511,10 +517,10 @@ TREXIO front end is modular, which simplifies implementation of new back ends.
|
|||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgf2e5d0b" class="outline-3">
|
<div id="outline-container-org500c687" class="outline-3">
|
||||||
<h3 id="orgf2e5d0b"><span class="section-number-3">2.1</span> Error handling</h3>
|
<h3 id="org500c687"><span class="section-number-3">2.1</span> Error handling</h3>
|
||||||
<div class="outline-text-3" id="text-2-1">
|
<div class="outline-text-3" id="text-2-1">
|
||||||
<table id="org46f433d" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
<table id="orgca665e1" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||||
|
|
||||||
|
|
||||||
<colgroup>
|
<colgroup>
|
||||||
@ -736,8 +742,8 @@ TREXIO front end is modular, which simplifies implementation of new back ends.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org5e02bcb" class="outline-4">
|
<div id="outline-container-org33d43d5" class="outline-4">
|
||||||
<h4 id="org5e02bcb"><span class="section-number-4">2.1.1</span> Decoding errors</h4>
|
<h4 id="org33d43d5"><span class="section-number-4">2.1.1</span> Decoding errors</h4>
|
||||||
<div class="outline-text-4" id="text-2-1-1">
|
<div class="outline-text-4" id="text-2-1-1">
|
||||||
<p>
|
<p>
|
||||||
The <code>trexio_string_of_error</code> converts an exit code into a string. The
|
The <code>trexio_string_of_error</code> converts an exit code into a string. The
|
||||||
@ -760,8 +766,8 @@ The text strings are extracted from the previous table.
|
|||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org0baf5b4" class="outline-5">
|
<div id="outline-container-org5790b7d" class="outline-5">
|
||||||
<h5 id="org0baf5b4"><span class="section-number-5">2.1.1.1</span> C source code</h5>
|
<h5 id="org5790b7d"><span class="section-number-5">2.1.1.1</span> C source code</h5>
|
||||||
<div class="outline-text-5" id="text-2-1-1-1">
|
<div class="outline-text-5" id="text-2-1-1-1">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #a020f0;">const</span> <span style="color: #228b22;">char</span>*
|
<pre class="src src-c"><span style="color: #a020f0;">const</span> <span style="color: #228b22;">char</span>*
|
||||||
@ -866,8 +872,8 @@ The text strings are extracted from the previous table.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgf31c3ed" class="outline-5">
|
<div id="outline-container-org2e427fd" class="outline-5">
|
||||||
<h5 id="orgf31c3ed"><span class="section-number-5">2.1.1.2</span> Fortran interface</h5>
|
<h5 id="org2e427fd"><span class="section-number-5">2.1.1.2</span> Fortran interface</h5>
|
||||||
<div class="outline-text-5" id="text-2-1-1-2">
|
<div class="outline-text-5" id="text-2-1-1-2">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-f90"><span style="color: #a020f0;">interface</span>
|
<pre class="src src-f90"><span style="color: #a020f0;">interface</span>
|
||||||
@ -883,8 +889,8 @@ The text strings are extracted from the previous table.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org3513a5d" class="outline-5">
|
<div id="outline-container-orgc234861" class="outline-5">
|
||||||
<h5 id="org3513a5d"><span class="section-number-5">2.1.1.3</span> Python interface</h5>
|
<h5 id="orgc234861"><span class="section-number-5">2.1.1.3</span> Python interface</h5>
|
||||||
<div class="outline-text-5" id="text-2-1-1-3">
|
<div class="outline-text-5" id="text-2-1-1-3">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-python"><span style="color: #a020f0;">class</span> <span style="color: #228b22;">Error</span>(<span style="color: #228b22;">Exception</span>):
|
<pre class="src src-python"><span style="color: #a020f0;">class</span> <span style="color: #228b22;">Error</span>(<span style="color: #228b22;">Exception</span>):
|
||||||
@ -923,8 +929,8 @@ The text strings are extracted from the previous table.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org3ee4132" class="outline-3">
|
<div id="outline-container-org72c0c90" class="outline-3">
|
||||||
<h3 id="org3ee4132"><span class="section-number-3">2.2</span> Back ends</h3>
|
<h3 id="org72c0c90"><span class="section-number-3">2.2</span> Back ends</h3>
|
||||||
<div class="outline-text-3" id="text-2-2">
|
<div class="outline-text-3" id="text-2-2">
|
||||||
<p>
|
<p>
|
||||||
TREXIO has several back ends:
|
TREXIO has several back ends:
|
||||||
@ -948,8 +954,8 @@ lines that correspond to the <code>TREXIO_JSON</code> back end (not implemented
|
|||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org2564d42" class="outline-4">
|
<div id="outline-container-orga37141f" class="outline-4">
|
||||||
<h4 id="org2564d42"><span class="section-number-4">2.2.1</span> C</h4>
|
<h4 id="orga37141f"><span class="section-number-4">2.2.1</span> C</h4>
|
||||||
<div class="outline-text-4" id="text-2-2-1">
|
<div class="outline-text-4" id="text-2-2-1">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #228b22;">int32_t</span> <span style="color: #228b22;">back_end_t</span>;
|
<pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #228b22;">int32_t</span> <span style="color: #228b22;">back_end_t</span>;
|
||||||
@ -965,8 +971,8 @@ lines that correspond to the <code>TREXIO_JSON</code> back end (not implemented
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org0c3c8dc" class="outline-4">
|
<div id="outline-container-org6ed185d" class="outline-4">
|
||||||
<h4 id="org0c3c8dc"><span class="section-number-4">2.2.2</span> Fortran</h4>
|
<h4 id="org6ed185d"><span class="section-number-4">2.2.2</span> Fortran</h4>
|
||||||
<div class="outline-text-4" id="text-2-2-2">
|
<div class="outline-text-4" id="text-2-2-2">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-f90"> <span style="color: #228b22;">integer</span>(trexio_backend), <span style="color: #a020f0;">parameter</span> ::<span style="color: #a0522d;"> TREXIO_HDF5 = 0</span>
|
<pre class="src src-f90"> <span style="color: #228b22;">integer</span>(trexio_backend), <span style="color: #a020f0;">parameter</span> ::<span style="color: #a0522d;"> TREXIO_HDF5 = 0</span>
|
||||||
@ -978,8 +984,8 @@ lines that correspond to the <code>TREXIO_JSON</code> back end (not implemented
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orga8769dd" class="outline-4">
|
<div id="outline-container-org98c597b" class="outline-4">
|
||||||
<h4 id="orga8769dd"><span class="section-number-4">2.2.3</span> Python</h4>
|
<h4 id="org98c597b"><span class="section-number-4">2.2.3</span> Python</h4>
|
||||||
<div class="outline-text-4" id="text-2-2-3">
|
<div class="outline-text-4" id="text-2-2-3">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-python"># <span style="color: #b22222;">define TREXIO back ends</span>
|
<pre class="src src-python"># <span style="color: #b22222;">define TREXIO back ends</span>
|
||||||
@ -993,8 +999,8 @@ lines that correspond to the <code>TREXIO_JSON</code> back end (not implemented
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org8dd8923" class="outline-3">
|
<div id="outline-container-org0c779da" class="outline-3">
|
||||||
<h3 id="org8dd8923"><span class="section-number-3">2.3</span> Read/write behavior</h3>
|
<h3 id="org0c779da"><span class="section-number-3">2.3</span> Read/write behavior</h3>
|
||||||
<div class="outline-text-3" id="text-2-3">
|
<div class="outline-text-3" id="text-2-3">
|
||||||
<p>
|
<p>
|
||||||
Every time a reading function is called, the data is read from the
|
Every time a reading function is called, the data is read from the
|
||||||
@ -1022,8 +1028,8 @@ concurrent programs, the behavior is not specified.
|
|||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div id="outline-container-orgb1fbb47" class="outline-3">
|
<div id="outline-container-orga0ee255" class="outline-3">
|
||||||
<h3 id="orgb1fbb47"><span class="section-number-3">2.4</span> TREXIO file type</h3>
|
<h3 id="orga0ee255"><span class="section-number-3">2.4</span> TREXIO file type</h3>
|
||||||
<div class="outline-text-3" id="text-2-4">
|
<div class="outline-text-3" id="text-2-4">
|
||||||
<p>
|
<p>
|
||||||
<code>trexio_s</code> is the the main type for TREXIO files, visible to the users
|
<code>trexio_s</code> is the the main type for TREXIO files, visible to the users
|
||||||
@ -1057,8 +1063,8 @@ TREXIO files will have as a first argument the TREXIO file handle.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgc076d8d" class="outline-4">
|
<div id="outline-container-orgd59c29e" class="outline-4">
|
||||||
<h4 id="orgc076d8d"><span class="section-number-4">2.4.1</span> TREXIO<sub>File</sub> Python class</h4>
|
<h4 id="orgd59c29e"><span class="section-number-4">2.4.1</span> TREXIO<sub>File</sub> Python class</h4>
|
||||||
<div class="outline-text-4" id="text-2-4-1">
|
<div class="outline-text-4" id="text-2-4-1">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-python"><span style="color: #a020f0;">class</span> <span style="color: #228b22;">File</span>:
|
<pre class="src src-python"><span style="color: #a020f0;">class</span> <span style="color: #228b22;">File</span>:
|
||||||
@ -1131,8 +1137,8 @@ TREXIO files will have as a first argument the TREXIO file handle.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orga1927ad" class="outline-3">
|
<div id="outline-container-org24d23e9" class="outline-3">
|
||||||
<h3 id="orga1927ad"><span class="section-number-3">2.5</span> Polymorphism of the file handle</h3>
|
<h3 id="org24d23e9"><span class="section-number-3">2.5</span> Polymorphism of the file handle</h3>
|
||||||
<div class="outline-text-3" id="text-2-5">
|
<div class="outline-text-3" id="text-2-5">
|
||||||
<p>
|
<p>
|
||||||
Polymorphism of the <code>trexio_t</code> type is handled by ensuring that the
|
Polymorphism of the <code>trexio_t</code> type is handled by ensuring that the
|
||||||
@ -1151,8 +1157,8 @@ corresponding types for all back ends can be safely casted to
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org0511c45" class="outline-3">
|
<div id="outline-container-orge917409" class="outline-3">
|
||||||
<h3 id="org0511c45"><span class="section-number-3">2.6</span> File opening</h3>
|
<h3 id="orge917409"><span class="section-number-3">2.6</span> File opening</h3>
|
||||||
<div class="outline-text-3" id="text-2-6">
|
<div class="outline-text-3" id="text-2-6">
|
||||||
<p>
|
<p>
|
||||||
<code>trexio_open</code> creates a new TREXIO file or opens existing one.
|
<code>trexio_open</code> creates a new TREXIO file or opens existing one.
|
||||||
@ -1191,8 +1197,8 @@ renaming the <code>.txt</code> data files.
|
|||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org38996c9" class="outline-4">
|
<div id="outline-container-org416f068" class="outline-4">
|
||||||
<h4 id="org38996c9"><span class="section-number-4">2.6.1</span> C</h4>
|
<h4 id="org416f068"><span class="section-number-4">2.6.1</span> C</h4>
|
||||||
<div class="outline-text-4" id="text-2-6-1">
|
<div class="outline-text-4" id="text-2-6-1">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #228b22;">trexio_t</span>*
|
<pre class="src src-c"><span style="color: #228b22;">trexio_t</span>*
|
||||||
@ -1346,8 +1352,8 @@ renaming the <code>.txt</code> data files.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org2d577fa" class="outline-4">
|
<div id="outline-container-org44ce5c3" class="outline-4">
|
||||||
<h4 id="org2d577fa"><span class="section-number-4">2.6.2</span> Fortran</h4>
|
<h4 id="org44ce5c3"><span class="section-number-4">2.6.2</span> Fortran</h4>
|
||||||
<div class="outline-text-4" id="text-2-6-2">
|
<div class="outline-text-4" id="text-2-6-2">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-f90"><span style="color: #a020f0;">interface</span>
|
<pre class="src src-f90"><span style="color: #a020f0;">interface</span>
|
||||||
@ -1364,8 +1370,8 @@ renaming the <code>.txt</code> data files.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgc308b03" class="outline-4">
|
<div id="outline-container-orgfbcedfc" class="outline-4">
|
||||||
<h4 id="orgc308b03"><span class="section-number-4">2.6.3</span> Python</h4>
|
<h4 id="orgfbcedfc"><span class="section-number-4">2.6.3</span> Python</h4>
|
||||||
<div class="outline-text-4" id="text-2-6-3">
|
<div class="outline-text-4" id="text-2-6-3">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-python"><span style="color: #a020f0;">def</span> <span style="color: #0000ff;">open</span>(file_name: <span style="color: #483d8b;">str</span>, mode: <span style="color: #483d8b;">str</span>, back_end: <span style="color: #483d8b;">int</span>):
|
<pre class="src src-python"><span style="color: #a020f0;">def</span> <span style="color: #0000ff;">open</span>(file_name: <span style="color: #483d8b;">str</span>, mode: <span style="color: #483d8b;">str</span>, back_end: <span style="color: #483d8b;">int</span>):
|
||||||
@ -1402,8 +1408,8 @@ renaming the <code>.txt</code> data files.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgfda21b7" class="outline-4">
|
<div id="outline-container-org67ab986" class="outline-4">
|
||||||
<h4 id="orgfda21b7"><span class="section-number-4">2.6.4</span> Zero-based versus one-based arrays of indices</h4>
|
<h4 id="org67ab986"><span class="section-number-4">2.6.4</span> Zero-based versus one-based arrays of indices</h4>
|
||||||
<div class="outline-text-4" id="text-2-6-4">
|
<div class="outline-text-4" id="text-2-6-4">
|
||||||
<p>
|
<p>
|
||||||
Because arrays are zero-based in Fortran, we need to set a flag to
|
Because arrays are zero-based in Fortran, we need to set a flag to
|
||||||
@ -1436,8 +1442,8 @@ know if we need to shift by 1 arrays of indices.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org8b08843" class="outline-3">
|
<div id="outline-container-org4a50e2f" class="outline-3">
|
||||||
<h3 id="org8b08843"><span class="section-number-3">2.7</span> File closing</h3>
|
<h3 id="org4a50e2f"><span class="section-number-3">2.7</span> File closing</h3>
|
||||||
<div class="outline-text-3" id="text-2-7">
|
<div class="outline-text-3" id="text-2-7">
|
||||||
<p>
|
<p>
|
||||||
<code>trexio_close</code> closes an existing <code>trexio_t</code> file.
|
<code>trexio_close</code> closes an existing <code>trexio_t</code> file.
|
||||||
@ -1454,8 +1460,8 @@ output:
|
|||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orga595c51" class="outline-4">
|
<div id="outline-container-org47cf699" class="outline-4">
|
||||||
<h4 id="orga595c51"><span class="section-number-4">2.7.1</span> C</h4>
|
<h4 id="org47cf699"><span class="section-number-4">2.7.1</span> C</h4>
|
||||||
<div class="outline-text-4" id="text-2-7-1">
|
<div class="outline-text-4" id="text-2-7-1">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
||||||
@ -1526,8 +1532,8 @@ output:
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orge6a8363" class="outline-4">
|
<div id="outline-container-org76b3ace" class="outline-4">
|
||||||
<h4 id="orge6a8363"><span class="section-number-4">2.7.2</span> Fortran</h4>
|
<h4 id="org76b3ace"><span class="section-number-4">2.7.2</span> Fortran</h4>
|
||||||
<div class="outline-text-4" id="text-2-7-2">
|
<div class="outline-text-4" id="text-2-7-2">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-f90"><span style="color: #a020f0;">interface</span>
|
<pre class="src src-f90"><span style="color: #a020f0;">interface</span>
|
||||||
@ -1541,8 +1547,8 @@ output:
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org6d2eb9c" class="outline-4">
|
<div id="outline-container-orgb20ec13" class="outline-4">
|
||||||
<h4 id="org6d2eb9c"><span class="section-number-4">2.7.3</span> Python</h4>
|
<h4 id="orgb20ec13"><span class="section-number-4">2.7.3</span> Python</h4>
|
||||||
<div class="outline-text-4" id="text-2-7-3">
|
<div class="outline-text-4" id="text-2-7-3">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-python"><span style="color: #a020f0;">def</span> <span style="color: #0000ff;">close</span>(trexio_file):
|
<pre class="src src-python"><span style="color: #a020f0;">def</span> <span style="color: #0000ff;">close</span>(trexio_file):
|
||||||
@ -1564,12 +1570,12 @@ output:
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org8a6d057" class="outline-2">
|
<div id="outline-container-orgb6c5610" class="outline-2">
|
||||||
<h2 id="org8a6d057"><span class="section-number-2">3</span> Templates for front end</h2>
|
<h2 id="orgb6c5610"><span class="section-number-2">3</span> Templates for front end</h2>
|
||||||
<div class="outline-text-2" id="text-3">
|
<div class="outline-text-2" id="text-3">
|
||||||
</div>
|
</div>
|
||||||
<div id="outline-container-org5d42594" class="outline-3">
|
<div id="outline-container-orgfd46f6b" class="outline-3">
|
||||||
<h3 id="org5d42594"><span class="section-number-3">3.1</span> Description</h3>
|
<h3 id="orgfd46f6b"><span class="section-number-3">3.1</span> Description</h3>
|
||||||
<div class="outline-text-3" id="text-3-1">
|
<div class="outline-text-3" id="text-3-1">
|
||||||
<p>
|
<p>
|
||||||
Consider the following block of <code>trex.json</code>:
|
Consider the following block of <code>trex.json</code>:
|
||||||
@ -1790,12 +1796,12 @@ value will result in <code>TREXIO_INVALID_ARG_2</code> exit code.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org900dc86" class="outline-3">
|
<div id="outline-container-orgf5b0ec7" class="outline-3">
|
||||||
<h3 id="org900dc86"><span class="section-number-3">3.2</span> Templates for front end has/read/write a single numerical attribute</h3>
|
<h3 id="orgf5b0ec7"><span class="section-number-3">3.2</span> Templates for front end has/read/write a single numerical attribute</h3>
|
||||||
<div class="outline-text-3" id="text-3-2">
|
<div class="outline-text-3" id="text-3-2">
|
||||||
</div>
|
</div>
|
||||||
<div id="outline-container-org31c29c0" class="outline-4">
|
<div id="outline-container-org208fee4" class="outline-4">
|
||||||
<h4 id="org31c29c0"><span class="section-number-4">3.2.1</span> Introduction</h4>
|
<h4 id="org208fee4"><span class="section-number-4">3.2.1</span> Introduction</h4>
|
||||||
<div class="outline-text-4" id="text-3-2-1">
|
<div class="outline-text-4" id="text-3-2-1">
|
||||||
<p>
|
<p>
|
||||||
This section concerns API calls related to numerical attributes,
|
This section concerns API calls related to numerical attributes,
|
||||||
@ -1866,8 +1872,8 @@ namely single value of int/float types.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgcd1853f" class="outline-4">
|
<div id="outline-container-org2365b3e" class="outline-4">
|
||||||
<h4 id="orgcd1853f"><span class="section-number-4">3.2.2</span> C templates for front end</h4>
|
<h4 id="org2365b3e"><span class="section-number-4">3.2.2</span> C templates for front end</h4>
|
||||||
<div class="outline-text-4" id="text-3-2-2">
|
<div class="outline-text-4" id="text-3-2-2">
|
||||||
<p>
|
<p>
|
||||||
The <code>C</code> templates that correspond to each of the abovementioned
|
The <code>C</code> templates that correspond to each of the abovementioned
|
||||||
@ -1881,12 +1887,12 @@ precision (see Table above).
|
|||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org47302c2" class="outline-5">
|
<div id="outline-container-org6b47a3b" class="outline-5">
|
||||||
<h5 id="org47302c2"><span class="section-number-5">3.2.2.1</span> Function declarations</h5>
|
<h5 id="org6b47a3b"><span class="section-number-5">3.2.2.1</span> Function declarations</h5>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org6f70115" class="outline-5">
|
<div id="outline-container-org237c62c" class="outline-5">
|
||||||
<h5 id="org6f70115"><span class="section-number-5">3.2.2.2</span> Source code for double precision functions</h5>
|
<h5 id="org237c62c"><span class="section-number-5">3.2.2.2</span> Source code for double precision functions</h5>
|
||||||
<div class="outline-text-5" id="text-3-2-2-2">
|
<div class="outline-text-5" id="text-3-2-2-2">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
||||||
@ -1947,8 +1953,8 @@ precision (see Table above).
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org9736201" class="outline-5">
|
<div id="outline-container-org999d6c3" class="outline-5">
|
||||||
<h5 id="org9736201"><span class="section-number-5">3.2.2.3</span> Source code for single precision functions</h5>
|
<h5 id="org999d6c3"><span class="section-number-5">3.2.2.3</span> Source code for single precision functions</h5>
|
||||||
<div class="outline-text-5" id="text-3-2-2-3">
|
<div class="outline-text-5" id="text-3-2-2-3">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
||||||
@ -2016,8 +2022,8 @@ precision (see Table above).
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orge8285a0" class="outline-5">
|
<div id="outline-container-org26d8210" class="outline-5">
|
||||||
<h5 id="orge8285a0"><span class="section-number-5">3.2.2.4</span> Source code for default functions</h5>
|
<h5 id="org26d8210"><span class="section-number-5">3.2.2.4</span> Source code for default functions</h5>
|
||||||
<div class="outline-text-5" id="text-3-2-2-4">
|
<div class="outline-text-5" id="text-3-2-2-4">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
||||||
@ -2070,8 +2076,8 @@ precision (see Table above).
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orga65cca9" class="outline-4">
|
<div id="outline-container-orgf2cbdf2" class="outline-4">
|
||||||
<h4 id="orga65cca9"><span class="section-number-4">3.2.3</span> Fortran templates for front end</h4>
|
<h4 id="orgf2cbdf2"><span class="section-number-4">3.2.3</span> Fortran templates for front end</h4>
|
||||||
<div class="outline-text-4" id="text-3-2-3">
|
<div class="outline-text-4" id="text-3-2-3">
|
||||||
<p>
|
<p>
|
||||||
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from Fortran.
|
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from Fortran.
|
||||||
@ -2156,8 +2162,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org1922bc8" class="outline-4">
|
<div id="outline-container-orge5872bb" class="outline-4">
|
||||||
<h4 id="org1922bc8"><span class="section-number-4">3.2.4</span> Python templates for front end</h4>
|
<h4 id="orge5872bb"><span class="section-number-4">3.2.4</span> Python templates for front end</h4>
|
||||||
<div class="outline-text-4" id="text-3-2-4">
|
<div class="outline-text-4" id="text-3-2-4">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-python"><span style="color: #a020f0;">def</span> <span style="color: #0000ff;">write_</span>$group_num$(trexio_file, num_w: $group_num_py_dtype$) -> <span style="color: #008b8b;">None</span>:
|
<pre class="src src-python"><span style="color: #a020f0;">def</span> <span style="color: #0000ff;">write_</span>$group_num$(trexio_file, num_w: $group_num_py_dtype$) -> <span style="color: #008b8b;">None</span>:
|
||||||
@ -2242,12 +2248,12 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org27c1425" class="outline-3">
|
<div id="outline-container-orgd2ea031" class="outline-3">
|
||||||
<h3 id="org27c1425"><span class="section-number-3">3.3</span> Templates for front end has/read/write a dataset of numerical data</h3>
|
<h3 id="orgd2ea031"><span class="section-number-3">3.3</span> Templates for front end has/read/write a dataset of numerical data</h3>
|
||||||
<div class="outline-text-3" id="text-3-3">
|
<div class="outline-text-3" id="text-3-3">
|
||||||
</div>
|
</div>
|
||||||
<div id="outline-container-orgcc0595b" class="outline-4">
|
<div id="outline-container-orgee0739a" class="outline-4">
|
||||||
<h4 id="orgcc0595b"><span class="section-number-4">3.3.1</span> Introduction</h4>
|
<h4 id="orgee0739a"><span class="section-number-4">3.3.1</span> Introduction</h4>
|
||||||
<div class="outline-text-4" id="text-3-3-1">
|
<div class="outline-text-4" id="text-3-3-1">
|
||||||
<p>
|
<p>
|
||||||
This section concerns API calls related to datasets.
|
This section concerns API calls related to datasets.
|
||||||
@ -2329,8 +2335,8 @@ This section concerns API calls related to datasets.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org12b314d" class="outline-4">
|
<div id="outline-container-orgdc30ab3" class="outline-4">
|
||||||
<h4 id="org12b314d"><span class="section-number-4">3.3.2</span> C templates for front end</h4>
|
<h4 id="orgdc30ab3"><span class="section-number-4">3.3.2</span> C templates for front end</h4>
|
||||||
<div class="outline-text-4" id="text-3-3-2">
|
<div class="outline-text-4" id="text-3-3-2">
|
||||||
<p>
|
<p>
|
||||||
The C templates that correspond to each of the abovementioned functions can be found below.
|
The C templates that correspond to each of the abovementioned functions can be found below.
|
||||||
@ -2341,13 +2347,13 @@ The basic (non-suffixed) API call on datasets deals with double precision (see T
|
|||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org3103bae" class="outline-5">
|
<div id="outline-container-org201267c" class="outline-5">
|
||||||
<h5 id="org3103bae"><span class="section-number-5">3.3.2.1</span> Function declarations</h5>
|
<h5 id="org201267c"><span class="section-number-5">3.3.2.1</span> Function declarations</h5>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
<div id="outline-container-org0a8782e" class="outline-5">
|
<div id="outline-container-org7f2264b" class="outline-5">
|
||||||
<h5 id="org0a8782e"><span class="section-number-5">3.3.2.2</span> Source code for double precision functions</h5>
|
<h5 id="org7f2264b"><span class="section-number-5">3.3.2.2</span> Source code for double precision functions</h5>
|
||||||
<div class="outline-text-5" id="text-3-3-2-2">
|
<div class="outline-text-5" id="text-3-3-2-2">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
||||||
@ -2475,8 +2481,8 @@ The basic (non-suffixed) API call on datasets deals with double precision (see T
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orga67b9d2" class="outline-5">
|
<div id="outline-container-org3eb7e15" class="outline-5">
|
||||||
<h5 id="orga67b9d2"><span class="section-number-5">3.3.2.3</span> Source code for single precision functions</h5>
|
<h5 id="org3eb7e15"><span class="section-number-5">3.3.2.3</span> Source code for single precision functions</h5>
|
||||||
<div class="outline-text-5" id="text-3-3-2-3">
|
<div class="outline-text-5" id="text-3-3-2-3">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
||||||
@ -2617,11 +2623,11 @@ The basic (non-suffixed) API call on datasets deals with double precision (see T
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgfc20175" class="outline-5">
|
<div id="outline-container-org0486967" class="outline-5">
|
||||||
<h5 id="orgfc20175"><span class="section-number-5">3.3.2.4</span> Source code for memory-safe functions</h5>
|
<h5 id="org0486967"><span class="section-number-5">3.3.2.4</span> Source code for memory-safe functions</h5>
|
||||||
<div class="outline-text-5" id="text-3-3-2-4">
|
<div class="outline-text-5" id="text-3-3-2-4">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c" id="org19f63cf"><span style="color: #228b22;">trexio_exit_code</span> <span style="color: #a0522d;">rc</span>;
|
<pre class="src src-c" id="org29a9bda"><span style="color: #228b22;">trexio_exit_code</span> <span style="color: #a0522d;">rc</span>;
|
||||||
int64_t $group_dset_dim$ = 0;
|
int64_t $group_dset_dim$ = 0;
|
||||||
|
|
||||||
/* <span style="color: #b22222;">Error handling for this call is added by the generator </span>*/
|
/* <span style="color: #b22222;">Error handling for this call is added by the generator </span>*/
|
||||||
@ -2777,8 +2783,8 @@ rc = trexio_read_$group_dset_dim$_64(file, &($group_dset_dim$));
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgeeb11da" class="outline-5">
|
<div id="outline-container-orgbc3f092" class="outline-5">
|
||||||
<h5 id="orgeeb11da"><span class="section-number-5">3.3.2.5</span> Source code for default functions</h5>
|
<h5 id="orgbc3f092"><span class="section-number-5">3.3.2.5</span> Source code for default functions</h5>
|
||||||
<div class="outline-text-5" id="text-3-3-2-5">
|
<div class="outline-text-5" id="text-3-3-2-5">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
||||||
@ -2852,8 +2858,8 @@ rc = trexio_read_$group_dset_dim$_64(file, &($group_dset_dim$));
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org8c31373" class="outline-4">
|
<div id="outline-container-org1f61d7e" class="outline-4">
|
||||||
<h4 id="org8c31373"><span class="section-number-4">3.3.3</span> Fortran templates for front end</h4>
|
<h4 id="org1f61d7e"><span class="section-number-4">3.3.3</span> Fortran templates for front end</h4>
|
||||||
<div class="outline-text-4" id="text-3-3-3">
|
<div class="outline-text-4" id="text-3-3-3">
|
||||||
<p>
|
<p>
|
||||||
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from <code>Fortran</code>.
|
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from <code>Fortran</code>.
|
||||||
@ -2938,8 +2944,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org24588f5" class="outline-4">
|
<div id="outline-container-orge2bfe6a" class="outline-4">
|
||||||
<h4 id="org24588f5"><span class="section-number-4">3.3.4</span> Python templates for front end</h4>
|
<h4 id="orge2bfe6a"><span class="section-number-4">3.3.4</span> Python templates for front end</h4>
|
||||||
<div class="outline-text-4" id="text-3-3-4">
|
<div class="outline-text-4" id="text-3-3-4">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-python"><span style="color: #a020f0;">def</span> <span style="color: #0000ff;">write_</span>$group_dset$(trexio_file, dset_w) -> <span style="color: #008b8b;">None</span>:
|
<pre class="src src-python"><span style="color: #a020f0;">def</span> <span style="color: #0000ff;">write_</span>$group_dset$(trexio_file, dset_w) -> <span style="color: #008b8b;">None</span>:
|
||||||
@ -3134,8 +3140,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org56044bb" class="outline-3">
|
<div id="outline-container-org659f3c1" class="outline-3">
|
||||||
<h3 id="org56044bb"><span class="section-number-3">3.4</span> Sparse data structures</h3>
|
<h3 id="org659f3c1"><span class="section-number-3">3.4</span> Sparse data structures</h3>
|
||||||
<div class="outline-text-3" id="text-3-4">
|
<div class="outline-text-3" id="text-3-4">
|
||||||
<p>
|
<p>
|
||||||
Sparse data structures are used typically for large tensors such as
|
Sparse data structures are used typically for large tensors such as
|
||||||
@ -3276,12 +3282,12 @@ For the values,
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org2680da5" class="outline-3">
|
<div id="outline-container-org87def1b" class="outline-3">
|
||||||
<h3 id="org2680da5"><span class="section-number-3">3.5</span> Templates for front end has/read/write a dataset of strings</h3>
|
<h3 id="org87def1b"><span class="section-number-3">3.5</span> Templates for front end has/read/write a dataset of strings</h3>
|
||||||
<div class="outline-text-3" id="text-3-5">
|
<div class="outline-text-3" id="text-3-5">
|
||||||
</div>
|
</div>
|
||||||
<div id="outline-container-orga75618f" class="outline-4">
|
<div id="outline-container-orgb0a00cb" class="outline-4">
|
||||||
<h4 id="orga75618f"><span class="section-number-4">3.5.1</span> Introduction</h4>
|
<h4 id="orgb0a00cb"><span class="section-number-4">3.5.1</span> Introduction</h4>
|
||||||
<div class="outline-text-4" id="text-3-5-1">
|
<div class="outline-text-4" id="text-3-5-1">
|
||||||
<p>
|
<p>
|
||||||
This section concerns API calls related to datasets of strings.
|
This section concerns API calls related to datasets of strings.
|
||||||
@ -3321,8 +3327,8 @@ This section concerns API calls related to datasets of strings.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgdcac756" class="outline-4">
|
<div id="outline-container-org3488fe4" class="outline-4">
|
||||||
<h4 id="orgdcac756"><span class="section-number-4">3.5.2</span> C templates for front end</h4>
|
<h4 id="org3488fe4"><span class="section-number-4">3.5.2</span> C templates for front end</h4>
|
||||||
<div class="outline-text-4" id="text-3-5-2">
|
<div class="outline-text-4" id="text-3-5-2">
|
||||||
<p>
|
<p>
|
||||||
First parameter is the <code>TREXIO</code> file handle. Second parameter is the variable to be written/read
|
First parameter is the <code>TREXIO</code> file handle. Second parameter is the variable to be written/read
|
||||||
@ -3330,12 +3336,12 @@ to/from the <code>TREXIO</code> file (except for <code>trexio_has_</code> functi
|
|||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org3498d98" class="outline-5">
|
<div id="outline-container-org47e3782" class="outline-5">
|
||||||
<h5 id="org3498d98"><span class="section-number-5">3.5.2.1</span> Function declarations</h5>
|
<h5 id="org47e3782"><span class="section-number-5">3.5.2.1</span> Function declarations</h5>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgd879998" class="outline-5">
|
<div id="outline-container-orge7a31a7" class="outline-5">
|
||||||
<h5 id="orgd879998"><span class="section-number-5">3.5.2.2</span> Source code for default functions</h5>
|
<h5 id="orge7a31a7"><span class="section-number-5">3.5.2.2</span> Source code for default functions</h5>
|
||||||
<div class="outline-text-5" id="text-3-5-2-2">
|
<div class="outline-text-5" id="text-3-5-2-2">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
||||||
@ -3577,8 +3583,8 @@ to/from the <code>TREXIO</code> file (except for <code>trexio_has_</code> functi
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org99028fc" class="outline-4">
|
<div id="outline-container-orgeb16281" class="outline-4">
|
||||||
<h4 id="org99028fc"><span class="section-number-4">3.5.3</span> Fortran templates for front end</h4>
|
<h4 id="orgeb16281"><span class="section-number-4">3.5.3</span> Fortran templates for front end</h4>
|
||||||
<div class="outline-text-4" id="text-3-5-3">
|
<div class="outline-text-4" id="text-3-5-3">
|
||||||
<p>
|
<p>
|
||||||
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from <code>Fortran</code>.
|
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from <code>Fortran</code>.
|
||||||
@ -3674,8 +3680,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgf37abe7" class="outline-4">
|
<div id="outline-container-org4d12235" class="outline-4">
|
||||||
<h4 id="orgf37abe7"><span class="section-number-4">3.5.4</span> Python templates for front end</h4>
|
<h4 id="org4d12235"><span class="section-number-4">3.5.4</span> Python templates for front end</h4>
|
||||||
<div class="outline-text-4" id="text-3-5-4">
|
<div class="outline-text-4" id="text-3-5-4">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-python"><span style="color: #a020f0;">def</span> <span style="color: #0000ff;">write_</span>$group_dset$(trexio_file, dset_w: <span style="color: #483d8b;">list</span>) -> <span style="color: #008b8b;">None</span>:
|
<pre class="src src-python"><span style="color: #a020f0;">def</span> <span style="color: #0000ff;">write_</span>$group_dset$(trexio_file, dset_w: <span style="color: #483d8b;">list</span>) -> <span style="color: #008b8b;">None</span>:
|
||||||
@ -3791,12 +3797,12 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgb6b5769" class="outline-3">
|
<div id="outline-container-orge4feb79" class="outline-3">
|
||||||
<h3 id="orgb6b5769"><span class="section-number-3">3.6</span> Templates for front end has/read/write a single string attribute</h3>
|
<h3 id="orge4feb79"><span class="section-number-3">3.6</span> Templates for front end has/read/write a single string attribute</h3>
|
||||||
<div class="outline-text-3" id="text-3-6">
|
<div class="outline-text-3" id="text-3-6">
|
||||||
</div>
|
</div>
|
||||||
<div id="outline-container-org670a0e2" class="outline-4">
|
<div id="outline-container-orgc77a321" class="outline-4">
|
||||||
<h4 id="org670a0e2"><span class="section-number-4">3.6.1</span> Introduction</h4>
|
<h4 id="orgc77a321"><span class="section-number-4">3.6.1</span> Introduction</h4>
|
||||||
<div class="outline-text-4" id="text-3-6-1">
|
<div class="outline-text-4" id="text-3-6-1">
|
||||||
<p>
|
<p>
|
||||||
This section concerns API calls related to string attributes.
|
This section concerns API calls related to string attributes.
|
||||||
@ -3836,16 +3842,16 @@ This section concerns API calls related to string attributes.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org3b19988" class="outline-4">
|
<div id="outline-container-orgf7b8294" class="outline-4">
|
||||||
<h4 id="org3b19988"><span class="section-number-4">3.6.2</span> C templates for front end</h4>
|
<h4 id="orgf7b8294"><span class="section-number-4">3.6.2</span> C templates for front end</h4>
|
||||||
<div class="outline-text-4" id="text-3-6-2">
|
<div class="outline-text-4" id="text-3-6-2">
|
||||||
</div>
|
</div>
|
||||||
<div id="outline-container-org055066b" class="outline-5">
|
<div id="outline-container-org14f3700" class="outline-5">
|
||||||
<h5 id="org055066b"><span class="section-number-5">3.6.2.1</span> Function declarations</h5>
|
<h5 id="org14f3700"><span class="section-number-5">3.6.2.1</span> Function declarations</h5>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgbfabf62" class="outline-5">
|
<div id="outline-container-orgd07b730" class="outline-5">
|
||||||
<h5 id="orgbfabf62"><span class="section-number-5">3.6.2.2</span> Source code for default functions</h5>
|
<h5 id="orgd07b730"><span class="section-number-5">3.6.2.2</span> Source code for default functions</h5>
|
||||||
<div class="outline-text-5" id="text-3-6-2-2">
|
<div class="outline-text-5" id="text-3-6-2-2">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
||||||
@ -3945,8 +3951,8 @@ This section concerns API calls related to string attributes.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org2fe674d" class="outline-4">
|
<div id="outline-container-org862805e" class="outline-4">
|
||||||
<h4 id="org2fe674d"><span class="section-number-4">3.6.3</span> Fortran templates for front end</h4>
|
<h4 id="org862805e"><span class="section-number-4">3.6.3</span> Fortran templates for front end</h4>
|
||||||
<div class="outline-text-4" id="text-3-6-3">
|
<div class="outline-text-4" id="text-3-6-3">
|
||||||
<p>
|
<p>
|
||||||
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from Fortran.
|
The <code>Fortran</code> templates that provide an access to the <code>C</code> API calls from Fortran.
|
||||||
@ -4023,8 +4029,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org0010428" class="outline-4">
|
<div id="outline-container-org2d66187" class="outline-4">
|
||||||
<h4 id="org0010428"><span class="section-number-4">3.6.4</span> Python templates for front end</h4>
|
<h4 id="org2d66187"><span class="section-number-4">3.6.4</span> Python templates for front end</h4>
|
||||||
<div class="outline-text-4" id="text-3-6-4">
|
<div class="outline-text-4" id="text-3-6-4">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-python"><span style="color: #a020f0;">def</span> <span style="color: #0000ff;">write_</span>$group_str$(trexio_file, str_w: <span style="color: #483d8b;">str</span>) -> <span style="color: #008b8b;">None</span>:
|
<pre class="src src-python"><span style="color: #a020f0;">def</span> <span style="color: #0000ff;">write_</span>$group_str$(trexio_file, str_w: <span style="color: #483d8b;">str</span>) -> <span style="color: #008b8b;">None</span>:
|
||||||
@ -4114,8 +4120,8 @@ These templates are based on the use of <code>iso_c_binding</code>. Pointers hav
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org979abdb" class="outline-2">
|
<div id="outline-container-orgbfd4c79" class="outline-2">
|
||||||
<h2 id="org979abdb"><span class="section-number-2">4</span> Fortran helper/wrapper functions</h2>
|
<h2 id="orgbfd4c79"><span class="section-number-2">4</span> Fortran helper/wrapper functions</h2>
|
||||||
<div class="outline-text-2" id="text-4">
|
<div class="outline-text-2" id="text-4">
|
||||||
<p>
|
<p>
|
||||||
The function below adapts the original C-based <code>trexio_open</code> for Fortran.
|
The function below adapts the original C-based <code>trexio_open</code> for Fortran.
|
||||||
@ -4249,7 +4255,7 @@ two code are identical, i.e. if the <code>assert</code> statement pass.
|
|||||||
</div>
|
</div>
|
||||||
<div id="postamble" class="status">
|
<div id="postamble" class="status">
|
||||||
<p class="author">Author: TREX-CoE</p>
|
<p class="author">Author: TREX-CoE</p>
|
||||||
<p class="date">Created: 2021-09-24 Fri 08:06</p>
|
<p class="date">Created: 2021-09-24 Fri 10:10</p>
|
||||||
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
||||||
</div>
|
</div>
|
||||||
</body>
|
</body>
|
||||||
|
@ -3,7 +3,7 @@
|
|||||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
||||||
<head>
|
<head>
|
||||||
<!-- 2021-09-24 Fri 08:06 -->
|
<!-- 2021-09-24 Fri 10:10 -->
|
||||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||||
<title>HDF5 back end</title>
|
<title>HDF5 back end</title>
|
||||||
@ -180,6 +180,12 @@
|
|||||||
.org-svg { width: 90%; }
|
.org-svg { width: 90%; }
|
||||||
/*]]>*/-->
|
/*]]>*/-->
|
||||||
</style>
|
</style>
|
||||||
|
<link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/css/htmlize.css"/>
|
||||||
|
<link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/css/readtheorg.css"/>
|
||||||
|
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
|
||||||
|
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
|
||||||
|
<script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/lib/js/jquery.stickytableheaders.min.js"></script>
|
||||||
|
<script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/js/readtheorg.js"></script>
|
||||||
<link rel="stylesheet" title="Standard" href="trexio.css" type="text/css" />
|
<link rel="stylesheet" title="Standard" href="trexio.css" type="text/css" />
|
||||||
|
|
||||||
<script type="text/javascript" src="org-info.js">
|
<script type="text/javascript" src="org-info.js">
|
||||||
@ -311,27 +317,27 @@ for the JavaScript code in this tag.
|
|||||||
<h2>Table of Contents</h2>
|
<h2>Table of Contents</h2>
|
||||||
<div id="text-table-of-contents">
|
<div id="text-table-of-contents">
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#orgab92e38">1. HDF5 back end</a>
|
<li><a href="#org6ce4ceb">1. HDF5 back end</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org6e90923">1.1. Template for HDF5 definitions</a></li>
|
<li><a href="#orgfa8475a">1.1. Template for HDF5 definitions</a></li>
|
||||||
<li><a href="#orgaba2d13">1.2. Template for HDF5 structures</a></li>
|
<li><a href="#org5add8c2">1.2. Template for HDF5 structures</a></li>
|
||||||
<li><a href="#org56b5378">1.3. Template for HDF5 init/deinit</a></li>
|
<li><a href="#orged361ef">1.3. Template for HDF5 init/deinit</a></li>
|
||||||
<li><a href="#org0540982">1.4. Template for HDF5 has/read/write the numerical attribute</a></li>
|
<li><a href="#orgad6dfa6">1.4. Template for HDF5 has/read/write the numerical attribute</a></li>
|
||||||
<li><a href="#orgdc21ed8">1.5. Template for HDF5 has/read/write the dataset of numerical data</a></li>
|
<li><a href="#org9813459">1.5. Template for HDF5 has/read/write the dataset of numerical data</a></li>
|
||||||
<li><a href="#orgf0f11b3">1.6. Template for HDF5 has/read/write the dataset of strings</a></li>
|
<li><a href="#orgf8babae">1.6. Template for HDF5 has/read/write the dataset of strings</a></li>
|
||||||
<li><a href="#org71ca595">1.7. Template for HDF5 has/read/write the string attribute</a></li>
|
<li><a href="#org36f25cd">1.7. Template for HDF5 has/read/write the string attribute</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgab92e38" class="outline-2">
|
<div id="outline-container-org6ce4ceb" class="outline-2">
|
||||||
<h2 id="orgab92e38"><span class="section-number-2">1</span> HDF5 back end</h2>
|
<h2 id="org6ce4ceb"><span class="section-number-2">1</span> HDF5 back end</h2>
|
||||||
<div class="outline-text-2" id="text-1">
|
<div class="outline-text-2" id="text-1">
|
||||||
</div>
|
</div>
|
||||||
<div id="outline-container-org6e90923" class="outline-3">
|
<div id="outline-container-orgfa8475a" class="outline-3">
|
||||||
<h3 id="org6e90923"><span class="section-number-3">1.1</span> Template for HDF5 definitions</h3>
|
<h3 id="orgfa8475a"><span class="section-number-3">1.1</span> Template for HDF5 definitions</h3>
|
||||||
<div class="outline-text-3" id="text-1-1">
|
<div class="outline-text-3" id="text-1-1">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #483d8b;">#define</span> $GROUP$_GROUP_NAME <span style="color: #8b2252;">"$group$"</span>
|
<pre class="src src-c"><span style="color: #483d8b;">#define</span> $GROUP$_GROUP_NAME <span style="color: #8b2252;">"$group$"</span>
|
||||||
@ -343,8 +349,8 @@ for the JavaScript code in this tag.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgaba2d13" class="outline-3">
|
<div id="outline-container-org5add8c2" class="outline-3">
|
||||||
<h3 id="orgaba2d13"><span class="section-number-3">1.2</span> Template for HDF5 structures</h3>
|
<h3 id="org5add8c2"><span class="section-number-3">1.2</span> Template for HDF5 structures</h3>
|
||||||
<div class="outline-text-3" id="text-1-2">
|
<div class="outline-text-3" id="text-1-2">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">trexio_hdf5_s</span> {
|
<pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">trexio_hdf5_s</span> {
|
||||||
@ -358,8 +364,8 @@ for the JavaScript code in this tag.
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
<div id="outline-container-org56b5378" class="outline-3">
|
<div id="outline-container-orged361ef" class="outline-3">
|
||||||
<h3 id="org56b5378"><span class="section-number-3">1.3</span> Template for HDF5 init/deinit</h3>
|
<h3 id="orged361ef"><span class="section-number-3">1.3</span> Template for HDF5 init/deinit</h3>
|
||||||
<div class="outline-text-3" id="text-1-3">
|
<div class="outline-text-3" id="text-1-3">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
||||||
@ -439,8 +445,8 @@ for the JavaScript code in this tag.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org0540982" class="outline-3">
|
<div id="outline-container-orgad6dfa6" class="outline-3">
|
||||||
<h3 id="org0540982"><span class="section-number-3">1.4</span> Template for HDF5 has/read/write the numerical attribute</h3>
|
<h3 id="orgad6dfa6"><span class="section-number-3">1.4</span> Template for HDF5 has/read/write the numerical attribute</h3>
|
||||||
<div class="outline-text-3" id="text-1-4">
|
<div class="outline-text-3" id="text-1-4">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
||||||
@ -534,8 +540,8 @@ for the JavaScript code in this tag.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgdc21ed8" class="outline-3">
|
<div id="outline-container-org9813459" class="outline-3">
|
||||||
<h3 id="orgdc21ed8"><span class="section-number-3">1.5</span> Template for HDF5 has/read/write the dataset of numerical data</h3>
|
<h3 id="org9813459"><span class="section-number-3">1.5</span> Template for HDF5 has/read/write the dataset of numerical data</h3>
|
||||||
<div class="outline-text-3" id="text-1-5">
|
<div class="outline-text-3" id="text-1-5">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
||||||
@ -658,8 +664,8 @@ for the JavaScript code in this tag.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgf0f11b3" class="outline-3">
|
<div id="outline-container-orgf8babae" class="outline-3">
|
||||||
<h3 id="orgf0f11b3"><span class="section-number-3">1.6</span> Template for HDF5 has/read/write the dataset of strings</h3>
|
<h3 id="orgf8babae"><span class="section-number-3">1.6</span> Template for HDF5 has/read/write the dataset of strings</h3>
|
||||||
<div class="outline-text-3" id="text-1-6">
|
<div class="outline-text-3" id="text-1-6">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
||||||
@ -864,8 +870,8 @@ for the JavaScript code in this tag.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org71ca595" class="outline-3">
|
<div id="outline-container-org36f25cd" class="outline-3">
|
||||||
<h3 id="org71ca595"><span class="section-number-3">1.7</span> Template for HDF5 has/read/write the string attribute</h3>
|
<h3 id="org36f25cd"><span class="section-number-3">1.7</span> Template for HDF5 has/read/write the string attribute</h3>
|
||||||
<div class="outline-text-3" id="text-1-7">
|
<div class="outline-text-3" id="text-1-7">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
||||||
@ -992,7 +998,7 @@ for the JavaScript code in this tag.
|
|||||||
</div>
|
</div>
|
||||||
<div id="postamble" class="status">
|
<div id="postamble" class="status">
|
||||||
<p class="author">Author: TREX-CoE</p>
|
<p class="author">Author: TREX-CoE</p>
|
||||||
<p class="date">Created: 2021-09-24 Fri 08:06</p>
|
<p class="date">Created: 2021-09-24 Fri 10:10</p>
|
||||||
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
||||||
</div>
|
</div>
|
||||||
</body>
|
</body>
|
||||||
|
@ -3,7 +3,7 @@
|
|||||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
||||||
<head>
|
<head>
|
||||||
<!-- 2021-09-24 Fri 08:06 -->
|
<!-- 2021-09-24 Fri 10:10 -->
|
||||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||||
<title>TEXT back end</title>
|
<title>TEXT back end</title>
|
||||||
@ -180,6 +180,12 @@
|
|||||||
.org-svg { width: 90%; }
|
.org-svg { width: 90%; }
|
||||||
/*]]>*/-->
|
/*]]>*/-->
|
||||||
</style>
|
</style>
|
||||||
|
<link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/css/htmlize.css"/>
|
||||||
|
<link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/css/readtheorg.css"/>
|
||||||
|
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
|
||||||
|
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
|
||||||
|
<script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/lib/js/jquery.stickytableheaders.min.js"></script>
|
||||||
|
<script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/js/readtheorg.js"></script>
|
||||||
<link rel="stylesheet" title="Standard" href="trexio.css" type="text/css" />
|
<link rel="stylesheet" title="Standard" href="trexio.css" type="text/css" />
|
||||||
|
|
||||||
<script type="text/javascript" src="org-info.js">
|
<script type="text/javascript" src="org-info.js">
|
||||||
@ -311,26 +317,26 @@ for the JavaScript code in this tag.
|
|||||||
<h2>Table of Contents</h2>
|
<h2>Table of Contents</h2>
|
||||||
<div id="text-table-of-contents">
|
<div id="text-table-of-contents">
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org8cdbde6">1. TEXT back end</a>
|
<li><a href="#orgeb34938">1. TEXT back end</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org2e3deb3">1.1. Template for group-related structures in text back end</a></li>
|
<li><a href="#orgc48738a">1.1. Template for group-related structures in text back end</a></li>
|
||||||
<li><a href="#org49cc18e">1.2. Template for general structure in text back end</a></li>
|
<li><a href="#org4eac29a">1.2. Template for general structure in text back end</a></li>
|
||||||
<li><a href="#org9d7450d">1.3. Initialize function (constant part)</a></li>
|
<li><a href="#org68de1b7">1.3. Initialize function (constant part)</a></li>
|
||||||
<li><a href="#orgc910e81">1.4. Deinitialize function (templated part)</a></li>
|
<li><a href="#org7c89560">1.4. Deinitialize function (templated part)</a></li>
|
||||||
<li><a href="#orgbe854e4">1.5. Template for text read struct</a></li>
|
<li><a href="#org223d8cb">1.5. Template for text read struct</a></li>
|
||||||
<li><a href="#org63e8ba3">1.6. Template for text flush struct</a></li>
|
<li><a href="#orgac26166">1.6. Template for text flush struct</a></li>
|
||||||
<li><a href="#orgabda98a">1.7. Template for text free memory</a></li>
|
<li><a href="#org706ddf6">1.7. Template for text free memory</a></li>
|
||||||
<li><a href="#orgc85a31e">1.8. Template for has/read/write the numerical attribute</a></li>
|
<li><a href="#orgb4c3557">1.8. Template for has/read/write the numerical attribute</a></li>
|
||||||
<li><a href="#org749a657">1.9. Template for has/read/write the dataset of numerical data</a></li>
|
<li><a href="#org863c47f">1.9. Template for has/read/write the dataset of numerical data</a></li>
|
||||||
<li><a href="#org6af27bd">1.10. Template for has/read/write the dataset of strings</a></li>
|
<li><a href="#org419e317">1.10. Template for has/read/write the dataset of strings</a></li>
|
||||||
<li><a href="#org6519d4d">1.11. Template for has/read/write the string attribute</a></li>
|
<li><a href="#org608a242">1.11. Template for has/read/write the string attribute</a></li>
|
||||||
<li><a href="#org6425052">1.12. RDM struct (hard-coded)</a>
|
<li><a href="#org4d28c11">1.12. RDM struct (hard-coded)</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org7d486e2">1.12.1. Read the complete struct</a></li>
|
<li><a href="#org4395208">1.12.1. Read the complete struct</a></li>
|
||||||
<li><a href="#orgd9f292f">1.12.2. Flush the complete struct</a></li>
|
<li><a href="#org891a63c">1.12.2. Flush the complete struct</a></li>
|
||||||
<li><a href="#orgad9810f">1.12.3. Free memory</a></li>
|
<li><a href="#org04b3416">1.12.3. Free memory</a></li>
|
||||||
<li><a href="#org3beb011">1.12.4. Read/Write the one<sub>e</sub> attribute</a></li>
|
<li><a href="#orgb45b0ad">1.12.4. Read/Write the one<sub>e</sub> attribute</a></li>
|
||||||
<li><a href="#org5f66576">1.12.5. Read/Write the two<sub>e</sub> attribute</a></li>
|
<li><a href="#orgd218b46">1.12.5. Read/Write the two<sub>e</sub> attribute</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
@ -339,8 +345,8 @@ for the JavaScript code in this tag.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org8cdbde6" class="outline-2">
|
<div id="outline-container-orgeb34938" class="outline-2">
|
||||||
<h2 id="org8cdbde6"><span class="section-number-2">1</span> TEXT back end</h2>
|
<h2 id="orgeb34938"><span class="section-number-2">1</span> TEXT back end</h2>
|
||||||
<div class="outline-text-2" id="text-1">
|
<div class="outline-text-2" id="text-1">
|
||||||
<p>
|
<p>
|
||||||
The "file" produced by the text back end is a directory with one
|
The "file" produced by the text back end is a directory with one
|
||||||
@ -361,8 +367,8 @@ The file is written when closed, or when the flush function is called.
|
|||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org2e3deb3" class="outline-3">
|
<div id="outline-container-orgc48738a" class="outline-3">
|
||||||
<h3 id="org2e3deb3"><span class="section-number-3">1.1</span> Template for group-related structures in text back end</h3>
|
<h3 id="orgc48738a"><span class="section-number-3">1.1</span> Template for group-related structures in text back end</h3>
|
||||||
<div class="outline-text-3" id="text-1-1">
|
<div class="outline-text-3" id="text-1-1">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> $group$_s {
|
<pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> $group$_s {
|
||||||
@ -381,8 +387,8 @@ The file is written when closed, or when the flush function is called.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org49cc18e" class="outline-3">
|
<div id="outline-container-org4eac29a" class="outline-3">
|
||||||
<h3 id="org49cc18e"><span class="section-number-3">1.2</span> Template for general structure in text back end</h3>
|
<h3 id="org4eac29a"><span class="section-number-3">1.2</span> Template for general structure in text back end</h3>
|
||||||
<div class="outline-text-3" id="text-1-2">
|
<div class="outline-text-3" id="text-1-2">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">rdm_s</span> {
|
<pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">rdm_s</span> {
|
||||||
@ -408,8 +414,8 @@ The file is written when closed, or when the flush function is called.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org9d7450d" class="outline-3">
|
<div id="outline-container-org68de1b7" class="outline-3">
|
||||||
<h3 id="org9d7450d"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3>
|
<h3 id="org68de1b7"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3>
|
||||||
<div class="outline-text-3" id="text-1-3">
|
<div class="outline-text-3" id="text-1-3">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
||||||
@ -510,8 +516,8 @@ The file is written when closed, or when the flush function is called.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgc910e81" class="outline-3">
|
<div id="outline-container-org7c89560" class="outline-3">
|
||||||
<h3 id="orgc910e81"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3>
|
<h3 id="org7c89560"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3>
|
||||||
<div class="outline-text-3" id="text-1-4">
|
<div class="outline-text-3" id="text-1-4">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
||||||
@ -536,8 +542,8 @@ The file is written when closed, or when the flush function is called.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgbe854e4" class="outline-3">
|
<div id="outline-container-org223d8cb" class="outline-3">
|
||||||
<h3 id="orgbe854e4"><span class="section-number-3">1.5</span> Template for text read struct</h3>
|
<h3 id="org223d8cb"><span class="section-number-3">1.5</span> Template for text read struct</h3>
|
||||||
<div class="outline-text-3" id="text-1-5">
|
<div class="outline-text-3" id="text-1-5">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c">$group$_t*
|
<pre class="src src-c">$group$_t*
|
||||||
@ -831,8 +837,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org63e8ba3" class="outline-3">
|
<div id="outline-container-orgac26166" class="outline-3">
|
||||||
<h3 id="org63e8ba3"><span class="section-number-3">1.6</span> Template for text flush struct</h3>
|
<h3 id="orgac26166"><span class="section-number-3">1.6</span> Template for text flush struct</h3>
|
||||||
<div class="outline-text-3" id="text-1-6">
|
<div class="outline-text-3" id="text-1-6">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
||||||
@ -897,8 +903,8 @@ trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <s
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgabda98a" class="outline-3">
|
<div id="outline-container-org706ddf6" class="outline-3">
|
||||||
<h3 id="orgabda98a"><span class="section-number-3">1.7</span> Template for text free memory</h3>
|
<h3 id="org706ddf6"><span class="section-number-3">1.7</span> Template for text free memory</h3>
|
||||||
<div class="outline-text-3" id="text-1-7">
|
<div class="outline-text-3" id="text-1-7">
|
||||||
<p>
|
<p>
|
||||||
Memory is allocated when reading. The following function frees memory.
|
Memory is allocated when reading. The following function frees memory.
|
||||||
@ -943,8 +949,8 @@ Memory is allocated when reading. The following function frees memory.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgc85a31e" class="outline-3">
|
<div id="outline-container-orgb4c3557" class="outline-3">
|
||||||
<h3 id="orgc85a31e"><span class="section-number-3">1.8</span> Template for has/read/write the numerical attribute</h3>
|
<h3 id="orgb4c3557"><span class="section-number-3">1.8</span> Template for has/read/write the numerical attribute</h3>
|
||||||
<div class="outline-text-3" id="text-1-8">
|
<div class="outline-text-3" id="text-1-8">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
||||||
@ -1007,8 +1013,8 @@ Memory is allocated when reading. The following function frees memory.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org749a657" class="outline-3">
|
<div id="outline-container-org863c47f" class="outline-3">
|
||||||
<h3 id="org749a657"><span class="section-number-3">1.9</span> Template for has/read/write the dataset of numerical data</h3>
|
<h3 id="org863c47f"><span class="section-number-3">1.9</span> Template for has/read/write the dataset of numerical data</h3>
|
||||||
<div class="outline-text-3" id="text-1-9">
|
<div class="outline-text-3" id="text-1-9">
|
||||||
<p>
|
<p>
|
||||||
The <code>group_dset</code> array is assumed allocated with the appropriate size.
|
The <code>group_dset</code> array is assumed allocated with the appropriate size.
|
||||||
@ -1104,8 +1110,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div id="outline-container-org6af27bd" class="outline-3">
|
<div id="outline-container-org419e317" class="outline-3">
|
||||||
<h3 id="org6af27bd"><span class="section-number-3">1.10</span> Template for has/read/write the dataset of strings</h3>
|
<h3 id="org419e317"><span class="section-number-3">1.10</span> Template for has/read/write the dataset of strings</h3>
|
||||||
<div class="outline-text-3" id="text-1-10">
|
<div class="outline-text-3" id="text-1-10">
|
||||||
<p>
|
<p>
|
||||||
The <code>group_dset</code> array is assumed allocated with the appropriate size.
|
The <code>group_dset</code> array is assumed allocated with the appropriate size.
|
||||||
@ -1206,8 +1212,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div id="outline-container-org6519d4d" class="outline-3">
|
<div id="outline-container-org608a242" class="outline-3">
|
||||||
<h3 id="org6519d4d"><span class="section-number-3">1.11</span> Template for has/read/write the string attribute</h3>
|
<h3 id="org608a242"><span class="section-number-3">1.11</span> Template for has/read/write the string attribute</h3>
|
||||||
<div class="outline-text-3" id="text-1-11">
|
<div class="outline-text-3" id="text-1-11">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
||||||
@ -1281,12 +1287,12 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div id="outline-container-org6425052" class="outline-3">
|
<div id="outline-container-org4d28c11" class="outline-3">
|
||||||
<h3 id="org6425052"><span class="section-number-3">1.12</span> RDM struct (hard-coded)</h3>
|
<h3 id="org4d28c11"><span class="section-number-3">1.12</span> RDM struct (hard-coded)</h3>
|
||||||
<div class="outline-text-3" id="text-1-12">
|
<div class="outline-text-3" id="text-1-12">
|
||||||
</div>
|
</div>
|
||||||
<div id="outline-container-org7d486e2" class="outline-4">
|
<div id="outline-container-org4395208" class="outline-4">
|
||||||
<h4 id="org7d486e2"><span class="section-number-4">1.12.1</span> Read the complete struct</h4>
|
<h4 id="org4395208"><span class="section-number-4">1.12.1</span> Read the complete struct</h4>
|
||||||
<div class="outline-text-4" id="text-1-12-1">
|
<div class="outline-text-4" id="text-1-12-1">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #228b22;">rdm_t</span>* <span style="color: #0000ff;">trexio_text_read_rdm</span>(<span style="color: #228b22;">trexio_text_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>);
|
<pre class="src src-c"><span style="color: #228b22;">rdm_t</span>* <span style="color: #0000ff;">trexio_text_read_rdm</span>(<span style="color: #228b22;">trexio_text_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>);
|
||||||
@ -1381,8 +1387,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgd9f292f" class="outline-4">
|
<div id="outline-container-org891a63c" class="outline-4">
|
||||||
<h4 id="orgd9f292f"><span class="section-number-4">1.12.2</span> Flush the complete struct</h4>
|
<h4 id="org891a63c"><span class="section-number-4">1.12.2</span> Flush the complete struct</h4>
|
||||||
<div class="outline-text-4" id="text-1-12-2">
|
<div class="outline-text-4" id="text-1-12-2">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <span style="color: #0000ff;">trexio_text_flush_rdm</span>(<span style="color: #228b22;">trexio_text_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>);
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <span style="color: #0000ff;">trexio_text_flush_rdm</span>(<span style="color: #228b22;">trexio_text_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>);
|
||||||
@ -1424,8 +1430,8 @@ The <code>group_dset</code> array is assumed allocated with the appropriate size
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgad9810f" class="outline-4">
|
<div id="outline-container-org04b3416" class="outline-4">
|
||||||
<h4 id="orgad9810f"><span class="section-number-4">1.12.3</span> Free memory</h4>
|
<h4 id="org04b3416"><span class="section-number-4">1.12.3</span> Free memory</h4>
|
||||||
<div class="outline-text-4" id="text-1-12-3">
|
<div class="outline-text-4" id="text-1-12-3">
|
||||||
<p>
|
<p>
|
||||||
Memory is allocated when reading. The followig function frees memory.
|
Memory is allocated when reading. The followig function frees memory.
|
||||||
@ -1461,8 +1467,8 @@ Memory is allocated when reading. The followig function frees memory.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org3beb011" class="outline-4">
|
<div id="outline-container-orgb45b0ad" class="outline-4">
|
||||||
<h4 id="org3beb011"><span class="section-number-4">1.12.4</span> Read/Write the one<sub>e</sub> attribute</h4>
|
<h4 id="orgb45b0ad"><span class="section-number-4">1.12.4</span> Read/Write the one<sub>e</sub> attribute</h4>
|
||||||
<div class="outline-text-4" id="text-1-12-4">
|
<div class="outline-text-4" id="text-1-12-4">
|
||||||
<p>
|
<p>
|
||||||
The <code>one_e</code> array is assumed allocated with the appropriate size.
|
The <code>one_e</code> array is assumed allocated with the appropriate size.
|
||||||
@ -1528,8 +1534,8 @@ The <code>one_e</code> array is assumed allocated with the appropriate size.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org5f66576" class="outline-4">
|
<div id="outline-container-orgd218b46" class="outline-4">
|
||||||
<h4 id="org5f66576"><span class="section-number-4">1.12.5</span> Read/Write the two<sub>e</sub> attribute</h4>
|
<h4 id="orgd218b46"><span class="section-number-4">1.12.5</span> Read/Write the two<sub>e</sub> attribute</h4>
|
||||||
<div class="outline-text-4" id="text-1-12-5">
|
<div class="outline-text-4" id="text-1-12-5">
|
||||||
<p>
|
<p>
|
||||||
<code>two_e</code> is a sparse data structure, which can be too large to fit
|
<code>two_e</code> is a sparse data structure, which can be too large to fit
|
||||||
@ -1637,7 +1643,7 @@ file for each sparse float structure.
|
|||||||
</div>
|
</div>
|
||||||
<div id="postamble" class="status">
|
<div id="postamble" class="status">
|
||||||
<p class="author">Author: TREX-CoE</p>
|
<p class="author">Author: TREX-CoE</p>
|
||||||
<p class="date">Created: 2021-09-24 Fri 08:06</p>
|
<p class="date">Created: 2021-09-24 Fri 10:10</p>
|
||||||
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
||||||
</div>
|
</div>
|
||||||
</body>
|
</body>
|
||||||
|
124
trex.html
@ -3,7 +3,7 @@
|
|||||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
||||||
<head>
|
<head>
|
||||||
<!-- 2021-09-24 Fri 08:06 -->
|
<!-- 2021-09-24 Fri 10:10 -->
|
||||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||||
<title>TREX Configuration file</title>
|
<title>TREX Configuration file</title>
|
||||||
@ -180,6 +180,12 @@
|
|||||||
.org-svg { width: 90%; }
|
.org-svg { width: 90%; }
|
||||||
/*]]>*/-->
|
/*]]>*/-->
|
||||||
</style>
|
</style>
|
||||||
|
<link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/css/htmlize.css"/>
|
||||||
|
<link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/css/readtheorg.css"/>
|
||||||
|
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
|
||||||
|
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
|
||||||
|
<script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/lib/js/jquery.stickytableheaders.min.js"></script>
|
||||||
|
<script type="text/javascript" src="https://fniessen.github.io/org-html-themes/src/readtheorg_theme/js/readtheorg.js"></script>
|
||||||
<link rel="stylesheet" title="Standard" href="trexio.css" type="text/css" />
|
<link rel="stylesheet" title="Standard" href="trexio.css" type="text/css" />
|
||||||
|
|
||||||
<script type="text/javascript" src="org-info.js">
|
<script type="text/javascript" src="org-info.js">
|
||||||
@ -333,28 +339,28 @@ for the JavaScript code in this tag.
|
|||||||
<h2>Table of Contents</h2>
|
<h2>Table of Contents</h2>
|
||||||
<div id="text-table-of-contents">
|
<div id="text-table-of-contents">
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#orgc1e3985">1. Metadata (metadata group)</a></li>
|
<li><a href="#org6ace8b1">1. Metadata (metadata group)</a></li>
|
||||||
<li><a href="#org3dd46bf">2. Electron (electron group)</a></li>
|
<li><a href="#org7131d20">2. Electron (electron group)</a></li>
|
||||||
<li><a href="#org7bb7f31">3. Nucleus (nucleus group)</a></li>
|
<li><a href="#orgbedb0a1">3. Nucleus (nucleus group)</a></li>
|
||||||
<li><a href="#org1d09690">4. Effective core potentials (ecp group)</a></li>
|
<li><a href="#org7a0c603">4. Effective core potentials (ecp group)</a></li>
|
||||||
<li><a href="#org271c37d">5. Basis set (basis group)</a></li>
|
<li><a href="#org43d2509">5. Basis set (basis group)</a></li>
|
||||||
<li><a href="#orgd708fe3">6. Atomic orbitals (ao group)</a>
|
<li><a href="#orge262f06">6. Atomic orbitals (ao group)</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#ao_one_e">6.1. One-electron integrals (<code>ao_1e_int</code> group)</a></li>
|
<li><a href="#ao_one_e">6.1. One-electron integrals (<code>ao_1e_int</code> group)</a></li>
|
||||||
<li><a href="#ao_two_e">6.2. Two-electron integrals (<code>ao_2e_int</code> group)</a></li>
|
<li><a href="#ao_two_e">6.2. Two-electron integrals (<code>ao_2e_int</code> group)</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#org5381aac">7. Molecular orbitals (mo group)</a>
|
<li><a href="#org7baed18">7. Molecular orbitals (mo group)</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#org482ed38">7.1. One-electron integrals (<code>mo_1e_int</code> group)</a></li>
|
<li><a href="#org0a9bbc6">7.1. One-electron integrals (<code>mo_1e_int</code> group)</a></li>
|
||||||
<li><a href="#org25d7b01">7.2. Two-electron integrals (<code>mo_2e_int</code> group)</a></li>
|
<li><a href="#org56ad27c">7.2. Two-electron integrals (<code>mo_2e_int</code> group)</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="#org39d09df">8. <span class="todo TODO">TODO</span> Slater determinants</a></li>
|
<li><a href="#org2ef3f55">8. <span class="todo TODO">TODO</span> Slater determinants</a></li>
|
||||||
<li><a href="#org03f33b9">9. <span class="todo TODO">TODO</span> Reduced density matrices (rdm group)</a></li>
|
<li><a href="#orgb20d291">9. <span class="todo TODO">TODO</span> Reduced density matrices (rdm group)</a></li>
|
||||||
<li><a href="#org764a990">10. Appendix</a>
|
<li><a href="#org67e7f16">10. Appendix</a>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#orga6ff242">10.1. Python script from table to json</a></li>
|
<li><a href="#org1a97c69">10.1. Python script from table to json</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
@ -396,8 +402,8 @@ arrays are 0-based. Hence, we introduce the <code>index</code> type which is an
|
|||||||
1-based <code>int</code> in the Fortran interface and 0-based otherwise.
|
1-based <code>int</code> in the Fortran interface and 0-based otherwise.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<div id="outline-container-orgc1e3985" class="outline-2">
|
<div id="outline-container-org6ace8b1" class="outline-2">
|
||||||
<h2 id="orgc1e3985"><span class="section-number-2">1</span> Metadata (metadata group)</h2>
|
<h2 id="org6ace8b1"><span class="section-number-2">1</span> Metadata (metadata group)</h2>
|
||||||
<div class="outline-text-2" id="text-1">
|
<div class="outline-text-2" id="text-1">
|
||||||
<p>
|
<p>
|
||||||
As we expect our files to be archived in open-data repositories, we
|
As we expect our files to be archived in open-data repositories, we
|
||||||
@ -407,7 +413,7 @@ which have participated to the creation of the file, a list of
|
|||||||
authors of the file, and a textual description.
|
authors of the file, and a textual description.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<table id="orga0b4cb4" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
<table id="orgd1d23de" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||||
|
|
||||||
|
|
||||||
<colgroup>
|
<colgroup>
|
||||||
@ -474,15 +480,15 @@ authors of the file, and a textual description.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org3dd46bf" class="outline-2">
|
<div id="outline-container-org7131d20" class="outline-2">
|
||||||
<h2 id="org3dd46bf"><span class="section-number-2">2</span> Electron (electron group)</h2>
|
<h2 id="org7131d20"><span class="section-number-2">2</span> Electron (electron group)</h2>
|
||||||
<div class="outline-text-2" id="text-2">
|
<div class="outline-text-2" id="text-2">
|
||||||
<p>
|
<p>
|
||||||
We consider wave functions expressed in the spin-free formalism, where
|
We consider wave functions expressed in the spin-free formalism, where
|
||||||
the number of ↑ and ↓ electrons is fixed.
|
the number of ↑ and ↓ electrons is fixed.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<table id="org40a58bb" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
<table id="org5e26465" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||||
|
|
||||||
|
|
||||||
<colgroup>
|
<colgroup>
|
||||||
@ -521,15 +527,15 @@ the number of ↑ and ↓ electrons is fixed.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org7bb7f31" class="outline-2">
|
<div id="outline-container-orgbedb0a1" class="outline-2">
|
||||||
<h2 id="org7bb7f31"><span class="section-number-2">3</span> Nucleus (nucleus group)</h2>
|
<h2 id="orgbedb0a1"><span class="section-number-2">3</span> Nucleus (nucleus group)</h2>
|
||||||
<div class="outline-text-2" id="text-3">
|
<div class="outline-text-2" id="text-3">
|
||||||
<p>
|
<p>
|
||||||
The nuclei are considered as fixed point charges. Coordinates are
|
The nuclei are considered as fixed point charges. Coordinates are
|
||||||
given in Cartesian \((x,y,z)\) format.
|
given in Cartesian \((x,y,z)\) format.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<table id="org34efec1" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
<table id="org68dc17e" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||||
|
|
||||||
|
|
||||||
<colgroup>
|
<colgroup>
|
||||||
@ -589,8 +595,8 @@ given in Cartesian \((x,y,z)\) format.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org1d09690" class="outline-2">
|
<div id="outline-container-org7a0c603" class="outline-2">
|
||||||
<h2 id="org1d09690"><span class="section-number-2">4</span> Effective core potentials (ecp group)</h2>
|
<h2 id="org7a0c603"><span class="section-number-2">4</span> Effective core potentials (ecp group)</h2>
|
||||||
<div class="outline-text-2" id="text-4">
|
<div class="outline-text-2" id="text-4">
|
||||||
<p>
|
<p>
|
||||||
An effective core potential (ECP) \(V_A^{\text{ECP}}\) replacing the
|
An effective core potential (ECP) \(V_A^{\text{ECP}}\) replacing the
|
||||||
@ -618,7 +624,7 @@ The functions \(V_{A\ell}\) are parameterized as:
|
|||||||
See <a href="http://dx.doi.org/10.1063/1.4984046">http://dx.doi.org/10.1063/1.4984046</a> for more info.
|
See <a href="http://dx.doi.org/10.1063/1.4984046">http://dx.doi.org/10.1063/1.4984046</a> for more info.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<table id="org6983136" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
<table id="org2a29490" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||||
|
|
||||||
|
|
||||||
<colgroup>
|
<colgroup>
|
||||||
@ -727,8 +733,8 @@ See <a href="http://dx.doi.org/10.1063/1.4984046">http://dx.doi.org/10.1063/1.49
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org271c37d" class="outline-2">
|
<div id="outline-container-org43d2509" class="outline-2">
|
||||||
<h2 id="org271c37d"><span class="section-number-2">5</span> Basis set (basis group)</h2>
|
<h2 id="org43d2509"><span class="section-number-2">5</span> Basis set (basis group)</h2>
|
||||||
<div class="outline-text-2" id="text-5">
|
<div class="outline-text-2" id="text-5">
|
||||||
<p>
|
<p>
|
||||||
We consider here basis functions centered on nuclei. Hence, we enable
|
We consider here basis functions centered on nuclei. Hence, we enable
|
||||||
@ -781,7 +787,7 @@ If the the basis function is not considered normalized, \(\mathcal{N}_s=1\).
|
|||||||
All the basis set parameters are stored in one-dimensional arrays:
|
All the basis set parameters are stored in one-dimensional arrays:
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<table id="org2558be2" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
<table id="orgcc40fa4" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||||
|
|
||||||
|
|
||||||
<colgroup>
|
<colgroup>
|
||||||
@ -950,8 +956,8 @@ prim_factor =
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-orgd708fe3" class="outline-2">
|
<div id="outline-container-orge262f06" class="outline-2">
|
||||||
<h2 id="orgd708fe3"><span class="section-number-2">6</span> Atomic orbitals (ao group)</h2>
|
<h2 id="orge262f06"><span class="section-number-2">6</span> Atomic orbitals (ao group)</h2>
|
||||||
<div class="outline-text-2" id="text-6">
|
<div class="outline-text-2" id="text-6">
|
||||||
<p>
|
<p>
|
||||||
Going from the atomic basis set to AOs implies a systematic
|
Going from the atomic basis set to AOs implies a systematic
|
||||||
@ -999,13 +1005,13 @@ shell, as in the GAMESS convention where
|
|||||||
|
|
||||||
<p>
|
<p>
|
||||||
In such a case, one should set the normalization of the shell (in
|
In such a case, one should set the normalization of the shell (in
|
||||||
the <a href="#org271c37d">Basis set</a> section) to \(\mathcal{N}_{z^2}\), which is the
|
the <a href="#org43d2509">Basis set</a> section) to \(\mathcal{N}_{z^2}\), which is the
|
||||||
normalization factor of the atomic orbitals in spherical coordinates.
|
normalization factor of the atomic orbitals in spherical coordinates.
|
||||||
The normalization factor of the \(xy\) function which should be
|
The normalization factor of the \(xy\) function which should be
|
||||||
introduced here should be \(\frac{\mathcal{N}_{xy}}{\mathcal{N}_{z^2}}\).
|
introduced here should be \(\frac{\mathcal{N}_{xy}}{\mathcal{N}_{z^2}}\).
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<table id="orgdcdae03" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
<table id="org41f960f" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||||
|
|
||||||
|
|
||||||
<colgroup>
|
<colgroup>
|
||||||
@ -1057,8 +1063,8 @@ introduced here should be \(\frac{\mathcal{N}_{xy}}{\mathcal{N}_{z^2}}\).
|
|||||||
</table>
|
</table>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org153f488" class="outline-3">
|
<div id="outline-container-orga756231" class="outline-3">
|
||||||
<h3 id="ao_one_e"><a id="org153f488"></a><span class="section-number-3">6.1</span> One-electron integrals (<code>ao_1e_int</code> group)</h3>
|
<h3 id="ao_one_e"><a id="orga756231"></a><span class="section-number-3">6.1</span> One-electron integrals (<code>ao_1e_int</code> group)</h3>
|
||||||
<div class="outline-text-3" id="text-ao_one_e">
|
<div class="outline-text-3" id="text-ao_one_e">
|
||||||
<ul class="org-ul">
|
<ul class="org-ul">
|
||||||
<li>\[ \hat{V}_{\text{ne}} = \sum_{A=1}^{N_\text{nucl}}
|
<li>\[ \hat{V}_{\text{ne}} = \sum_{A=1}^{N_\text{nucl}}
|
||||||
@ -1076,7 +1082,7 @@ The one-electron integrals for a one-electron operator \(\hat{O}\) are
|
|||||||
over atomic orbitals.
|
over atomic orbitals.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<table id="org25c35a9" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
<table id="org03807cc" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||||
|
|
||||||
|
|
||||||
<colgroup>
|
<colgroup>
|
||||||
@ -1143,8 +1149,8 @@ over atomic orbitals.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org74f0d04" class="outline-3">
|
<div id="outline-container-orged2c27b" class="outline-3">
|
||||||
<h3 id="ao_two_e"><a id="org74f0d04"></a><span class="section-number-3">6.2</span> Two-electron integrals (<code>ao_2e_int</code> group)</h3>
|
<h3 id="ao_two_e"><a id="orged2c27b"></a><span class="section-number-3">6.2</span> Two-electron integrals (<code>ao_2e_int</code> group)</h3>
|
||||||
<div class="outline-text-3" id="text-ao_two_e">
|
<div class="outline-text-3" id="text-ao_two_e">
|
||||||
<p>
|
<p>
|
||||||
The two-electron integrals for a two-electron operator \(\hat{O}\) are
|
The two-electron integrals for a two-electron operator \(\hat{O}\) are
|
||||||
@ -1165,7 +1171,7 @@ notation.
|
|||||||
\mathbf{r}_j \vert)}{\vert \mathbf{r}_i - \mathbf{r}_j \vert} \] : electron-electron long range potential</li>
|
\mathbf{r}_j \vert)}{\vert \mathbf{r}_i - \mathbf{r}_j \vert} \] : electron-electron long range potential</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<table id="org80b6ea9" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
<table id="org96bae30" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||||
|
|
||||||
|
|
||||||
<colgroup>
|
<colgroup>
|
||||||
@ -1205,10 +1211,10 @@ notation.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org5381aac" class="outline-2">
|
<div id="outline-container-org7baed18" class="outline-2">
|
||||||
<h2 id="org5381aac"><span class="section-number-2">7</span> Molecular orbitals (mo group)</h2>
|
<h2 id="org7baed18"><span class="section-number-2">7</span> Molecular orbitals (mo group)</h2>
|
||||||
<div class="outline-text-2" id="text-7">
|
<div class="outline-text-2" id="text-7">
|
||||||
<table id="orgd30694f" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
<table id="orgfb122e3" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||||
|
|
||||||
|
|
||||||
<colgroup>
|
<colgroup>
|
||||||
@ -1274,8 +1280,8 @@ notation.
|
|||||||
</table>
|
</table>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org482ed38" class="outline-3">
|
<div id="outline-container-org0a9bbc6" class="outline-3">
|
||||||
<h3 id="org482ed38"><span class="section-number-3">7.1</span> One-electron integrals (<code>mo_1e_int</code> group)</h3>
|
<h3 id="org0a9bbc6"><span class="section-number-3">7.1</span> One-electron integrals (<code>mo_1e_int</code> group)</h3>
|
||||||
<div class="outline-text-3" id="text-7-1">
|
<div class="outline-text-3" id="text-7-1">
|
||||||
<p>
|
<p>
|
||||||
The operators as the same as those defined in the
|
The operators as the same as those defined in the
|
||||||
@ -1283,7 +1289,7 @@ The operators as the same as those defined in the
|
|||||||
the basis of molecular orbitals.
|
the basis of molecular orbitals.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<table id="orge35bb96" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
<table id="orgdd2cd7f" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||||
|
|
||||||
|
|
||||||
<colgroup>
|
<colgroup>
|
||||||
@ -1350,8 +1356,8 @@ the basis of molecular orbitals.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org25d7b01" class="outline-3">
|
<div id="outline-container-org56ad27c" class="outline-3">
|
||||||
<h3 id="org25d7b01"><span class="section-number-3">7.2</span> Two-electron integrals (<code>mo_2e_int</code> group)</h3>
|
<h3 id="org56ad27c"><span class="section-number-3">7.2</span> Two-electron integrals (<code>mo_2e_int</code> group)</h3>
|
||||||
<div class="outline-text-3" id="text-7-2">
|
<div class="outline-text-3" id="text-7-2">
|
||||||
<p>
|
<p>
|
||||||
The operators as the same as those defined in the
|
The operators as the same as those defined in the
|
||||||
@ -1359,7 +1365,7 @@ The operators as the same as those defined in the
|
|||||||
the basis of molecular orbitals.
|
the basis of molecular orbitals.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<table id="org6ec3a81" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
<table id="orgf067b44" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||||
|
|
||||||
|
|
||||||
<colgroup>
|
<colgroup>
|
||||||
@ -1399,13 +1405,13 @@ the basis of molecular orbitals.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org39d09df" class="outline-2">
|
<div id="outline-container-org2ef3f55" class="outline-2">
|
||||||
<h2 id="org39d09df"><span class="section-number-2">8</span> <span class="todo TODO">TODO</span> Slater determinants</h2>
|
<h2 id="org2ef3f55"><span class="section-number-2">8</span> <span class="todo TODO">TODO</span> Slater determinants</h2>
|
||||||
</div>
|
</div>
|
||||||
<div id="outline-container-org03f33b9" class="outline-2">
|
<div id="outline-container-orgb20d291" class="outline-2">
|
||||||
<h2 id="org03f33b9"><span class="section-number-2">9</span> <span class="todo TODO">TODO</span> Reduced density matrices (rdm group)</h2>
|
<h2 id="orgb20d291"><span class="section-number-2">9</span> <span class="todo TODO">TODO</span> Reduced density matrices (rdm group)</h2>
|
||||||
<div class="outline-text-2" id="text-9">
|
<div class="outline-text-2" id="text-9">
|
||||||
<table id="org508bf6c" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
<table id="org451fbad" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||||
|
|
||||||
|
|
||||||
<colgroup>
|
<colgroup>
|
||||||
@ -1458,15 +1464,15 @@ the basis of molecular orbitals.
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="outline-container-org764a990" class="outline-2">
|
<div id="outline-container-org67e7f16" class="outline-2">
|
||||||
<h2 id="org764a990"><span class="section-number-2">10</span> Appendix</h2>
|
<h2 id="org67e7f16"><span class="section-number-2">10</span> Appendix</h2>
|
||||||
<div class="outline-text-2" id="text-10">
|
<div class="outline-text-2" id="text-10">
|
||||||
</div>
|
</div>
|
||||||
<div id="outline-container-orga6ff242" class="outline-3">
|
<div id="outline-container-org1a97c69" class="outline-3">
|
||||||
<h3 id="orga6ff242"><span class="section-number-3">10.1</span> Python script from table to json</h3>
|
<h3 id="org1a97c69"><span class="section-number-3">10.1</span> Python script from table to json</h3>
|
||||||
<div class="outline-text-3" id="text-10-1">
|
<div class="outline-text-3" id="text-10-1">
|
||||||
<div class="org-src-container">
|
<div class="org-src-container">
|
||||||
<pre class="src src-python" id="org2ea24f3"><span style="color: #a020f0;">print</span>(<span style="color: #8b2252;">"""#+begin_src python :tangle trex.json"""</span>)
|
<pre class="src src-python" id="orgf2be65c"><span style="color: #a020f0;">print</span>(<span style="color: #8b2252;">"""#+begin_src python :tangle trex.json"""</span>)
|
||||||
<span style="color: #a020f0;">print</span>(<span style="color: #8b2252;">""" "%s": {"""</span>%(title))
|
<span style="color: #a020f0;">print</span>(<span style="color: #8b2252;">""" "%s": {"""</span>%(title))
|
||||||
<span style="color: #a0522d;">indent</span> = <span style="color: #8b2252;">" "</span>
|
<span style="color: #a0522d;">indent</span> = <span style="color: #8b2252;">" "</span>
|
||||||
<span style="color: #a0522d;">f1</span> = 0 ; <span style="color: #a0522d;">f2</span> = 0 ; <span style="color: #a0522d;">f3</span> = 0
|
<span style="color: #a0522d;">f1</span> = 0 ; <span style="color: #a0522d;">f2</span> = 0 ; <span style="color: #a0522d;">f3</span> = 0
|
||||||
@ -1519,7 +1525,7 @@ the basis of molecular orbitals.
|
|||||||
</div>
|
</div>
|
||||||
<div id="postamble" class="status">
|
<div id="postamble" class="status">
|
||||||
<p class="author">Author: TREX-CoE</p>
|
<p class="author">Author: TREX-CoE</p>
|
||||||
<p class="date">Created: 2021-09-24 Fri 08:06</p>
|
<p class="date">Created: 2021-09-24 Fri 10:10</p>
|
||||||
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
||||||
</div>
|
</div>
|
||||||
</body>
|
</body>
|
||||||
|