jiri/org-ql
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Docs: (defpred.org) Add HTML export

Browse source 
It looks nice, even if it isn't practically viewable on GitHub.
This commit is contained in:
Adam Porter 2020-11-23 03:19:13 -06:00
parent b01106bd0f
commit 92d099caf6
25 changed files with 2257 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

766
examples/defpred.html Normal file
View file

@ -0,0 +1,766 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2020-11-23 Mon 03:31 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Org QL Custom Predicates Tutorial</title>
<meta name="generator" content="Org mode" />
<style type="text/css">
<!--/*--><![CDATA[/*><!--*/
.title { text-align: center;
margin-bottom: .2em; }
.subtitle { text-align: center;
font-size: medium;
font-weight: bold;
margin-top:0; }
.todo { font-family: monospace; color: red; }
.done { font-family: monospace; color: green; }
.priority { font-family: monospace; color: orange; }
.tag { background-color: #eee; font-family: monospace;
padding: 2px; font-size: 80%; font-weight: normal; }
.timestamp { color: #bebebe; }
.timestamp-kwd { color: #5f9ea0; }
.org-right { margin-left: auto; margin-right: 0px; text-align: right; }
.org-left { margin-left: 0px; margin-right: auto; text-align: left; }
.org-center { margin-left: auto; margin-right: auto; text-align: center; }
.underline { text-decoration: underline; }
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
p.verse { margin-left: 3%; }
pre {
border: 1px solid #ccc;
box-shadow: 3px 3px 3px #eee;
padding: 8pt;
font-family: monospace;
overflow: auto;
margin: 1.2em;
}
pre.src {
position: relative;
overflow: visible;
padding-top: 1.2em;
}
pre.src:before {
display: none;
position: absolute;
background-color: white;
top: -10px;
right: 10px;
padding: 3px;
border: 1px solid black;
}
pre.src:hover:before { display: inline;}
/* Languages per Org manual */
pre.src-asymptote:before { content: 'Asymptote'; }
pre.src-awk:before { content: 'Awk'; }
pre.src-C:before { content: 'C'; }
/* pre.src-C++ doesn't work in CSS */
pre.src-clojure:before { content: 'Clojure'; }
pre.src-css:before { content: 'CSS'; }
pre.src-D:before { content: 'D'; }
pre.src-ditaa:before { content: 'ditaa'; }
pre.src-dot:before { content: 'Graphviz'; }
pre.src-calc:before { content: 'Emacs Calc'; }
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
pre.src-fortran:before { content: 'Fortran'; }
pre.src-gnuplot:before { content: 'gnuplot'; }
pre.src-haskell:before { content: 'Haskell'; }
pre.src-java:before { content: 'Java'; }
pre.src-js:before { content: 'Javascript'; }
pre.src-latex:before { content: 'LaTeX'; }
pre.src-ledger:before { content: 'Ledger'; }
pre.src-lisp:before { content: 'Lisp'; }
pre.src-lilypond:before { content: 'Lilypond'; }
pre.src-lua:before { content: 'Lua'; }
pre.src-matlab:before { content: 'MATLAB'; }
pre.src-mscgen:before { content: 'Mscgen'; }
pre.src-ocaml:before { content: 'Objective Caml'; }
pre.src-octave:before { content: 'Octave'; }
pre.src-org:before { content: 'Org mode'; }
pre.src-oz:before { content: 'OZ'; }
pre.src-plantuml:before { content: 'Plantuml'; }
pre.src-processing:before { content: 'Processing.js'; }
pre.src-python:before { content: 'Python'; }
pre.src-R:before { content: 'R'; }
pre.src-ruby:before { content: 'Ruby'; }
pre.src-sass:before { content: 'Sass'; }
pre.src-scheme:before { content: 'Scheme'; }
pre.src-screen:before { content: 'Gnu Screen'; }
pre.src-sed:before { content: 'Sed'; }
pre.src-sh:before { content: 'shell'; }
pre.src-sql:before { content: 'SQL'; }
pre.src-sqlite:before { content: 'SQLite'; }
/* additional languages in org.el's org-babel-load-languages alist */
pre.src-forth:before { content: 'Forth'; }
pre.src-io:before { content: 'IO'; }
pre.src-J:before { content: 'J'; }
pre.src-makefile:before { content: 'Makefile'; }
pre.src-maxima:before { content: 'Maxima'; }
pre.src-perl:before { content: 'Perl'; }
pre.src-picolisp:before { content: 'Pico Lisp'; }
pre.src-scala:before { content: 'Scala'; }
pre.src-shell:before { content: 'Shell Script'; }
pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
/* additional language identifiers per "defun org-babel-execute"
in ob-*.el */
pre.src-cpp:before { content: 'C++'; }
pre.src-abc:before { content: 'ABC'; }
pre.src-coq:before { content: 'Coq'; }
pre.src-groovy:before { content: 'Groovy'; }
/* additional language identifiers from org-babel-shell-names in
ob-shell.el: ob-shell is the only babel language using a lambda to put
the execution function name together. */
pre.src-bash:before { content: 'bash'; }
pre.src-csh:before { content: 'csh'; }
pre.src-ash:before { content: 'ash'; }
pre.src-dash:before { content: 'dash'; }
pre.src-ksh:before { content: 'ksh'; }
pre.src-mksh:before { content: 'mksh'; }
pre.src-posh:before { content: 'posh'; }
/* Additional Emacs modes also supported by the LaTeX listings package */
pre.src-ada:before { content: 'Ada'; }
pre.src-asm:before { content: 'Assembler'; }
pre.src-caml:before { content: 'Caml'; }
pre.src-delphi:before { content: 'Delphi'; }
pre.src-html:before { content: 'HTML'; }
pre.src-idl:before { content: 'IDL'; }
pre.src-mercury:before { content: 'Mercury'; }
pre.src-metapost:before { content: 'MetaPost'; }
pre.src-modula-2:before { content: 'Modula-2'; }
pre.src-pascal:before { content: 'Pascal'; }
pre.src-ps:before { content: 'PostScript'; }
pre.src-prolog:before { content: 'Prolog'; }
pre.src-simula:before { content: 'Simula'; }
pre.src-tcl:before { content: 'tcl'; }
pre.src-tex:before { content: 'TeX'; }
pre.src-plain-tex:before { content: 'Plain TeX'; }
pre.src-verilog:before { content: 'Verilog'; }
pre.src-vhdl:before { content: 'VHDL'; }
pre.src-xml:before { content: 'XML'; }
pre.src-nxml:before { content: 'XML'; }
/* add a generic configuration mode; LaTeX export needs an additional
(add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
pre.src-conf:before { content: 'Configuration File'; }
table { border-collapse:collapse; }
caption.t-above { caption-side: top; }
caption.t-bottom { caption-side: bottom; }
td, th { vertical-align:top; }
th.org-right { text-align: center; }
th.org-left { text-align: center; }
th.org-center { text-align: center; }
td.org-right { text-align: right; }
td.org-left { text-align: left; }
td.org-center { text-align: center; }
dt { font-weight: bold; }
.footpara { display: inline; }
.footdef { margin-bottom: 1em; }
.figure { padding: 1em; }
.figure p { text-align: center; }
.inlinetask {
padding: 10px;
border: 2px solid gray;
margin: 10px;
background: #ffffcc;
}
#org-div-home-and-up
{ text-align: right; font-size: 70%; white-space: nowrap; }
textarea { overflow-x: auto; }
.linenr { font-size: smaller }
.code-highlighted { background-color: #ffff00; }
.org-info-js_info-navigation { border-style: none; }
#org-info-js_console-label
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
.org-info-js_search-highlight
{ background-color: #ffff00; color: #000000; font-weight: bold; }
.org-svg { width: 90%; }
/*]]>*/-->
</style>
<link rel="stylesheet" type="text/css" href="export/styles/darksun/css/darksun.css"/>
<script type="text/javascript" src="export/styles/darksun/js/jquery-1.11.0.min.js"></script>
<script type="text/javascript" src="export/styles/darksun/js/jquery-ui-1.10.2.min.js"></script>
<script type="text/javascript" src="export/styles/darksun/js/jquery.localscroll-min.js"></script>
<script type="text/javascript" src="export/styles/darksun/js/jquery.scrollTo-1.4.3.1-min.js"></script>
<script type="text/javascript" src="export/styles/darksun/js/jquery.zclip.min.js"></script>
<script type="text/javascript" src="export/styles/darksun/js/darksun.js"></script>
<script type="text/javascript" src="export/styles/lib/js/jquery.stickytableheaders.min.js"></script>
<script type="text/javascript">
/*
@licstart The following is the entire license notice for the
JavaScript code in this tag.
Copyright (C) 2012-2013 Free Software Foundation, Inc.
The JavaScript code in this tag is free software: you can
redistribute it and/or modify it under the terms of the GNU
General Public License (GNU GPL) as published by the Free Software
Foundation, either version 3 of the License, or (at your option)
any later version. The code is distributed WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
As additional permission under GNU GPL version 3 section 7, you
may distribute non-source (e.g., minimized or compacted) forms of
that code without the copy of the GNU GPL normally required by
section 4, provided you include this license notice and a URL
through which recipients can access the Corresponding Source.
@licend The above is the entire license notice
for the JavaScript code in this tag.
*/
<!--/*--><![CDATA[/*><!--*/
function CodeHighlightOn(elem, id)
{
var target = document.getElementById(id);
if(null != target) {
elem.cacheClassElem = elem.className;
elem.cacheClassTarget = target.className;
target.className = "code-highlighted";
elem.className = "code-highlighted";
}
}
function CodeHighlightOff(elem, id)
{
var target = document.getElementById(id);
if(elem.cacheClassElem)
elem.className = elem.cacheClassElem;
if(elem.cacheClassTarget)
target.className = elem.cacheClassTarget;
}
/*]]>*///-->
</script>
</head>
<body>
<div id="content">
<h1 class="title">Org QL Custom Predicates Tutorial</h1>
<div id="table-of-contents">
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#Using%20built-in%20predicates">Using built-in predicates</a></li>
<li><a href="#A%20custom%20~%28person%29~%20predicate">A custom <code>(person)</code> predicate</a></li>
<li><a href="#Searching%20for%20multiple%20people%20at%20once">Searching for multiple people at once</a></li>
<li><a href="#Normalizing%20queries%20to%20rewrite%20arguments">Normalizing queries to rewrite arguments</a></li>
<li><a href="#Non-sexp%20query%20syntax">Non-sexp query syntax</a></li>
<li><a href="#Using%20multiple%20predicates">Using multiple predicates</a></li>
<li><a href="#Predicate%20aliases">Predicate aliases</a></li>
<li><a href="#Be%20formless">Be formless</a></li>
<li><a href="#Conclusion">Conclusion</a></li>
<li><a href="#Appendix%3A%20Anaphoric%20macros">Appendix: Anaphoric macros</a></li>
<li><a href="#Example%20data">Example data</a>
<ul>
<li><a href="#Loud%20pet%20parakeet">Loud pet parakeet&#xa0;&#xa0;&#xa0;<span class="tag"><span class="personAlice">personAlice</span></span></a></li>
<li><a href="#Missing%20sticky%20notes">Missing sticky notes&#xa0;&#xa0;&#xa0;<span class="tag"><span class="personAlice">personAlice</span></span></a></li>
<li><a href="#Dirty%20dishes%20in%20sink">Dirty dishes in sink&#xa0;&#xa0;&#xa0;<span class="tag"><span class="personAlice">personAlice</span></span></a></li>
<li><a href="#Stinky%20coffee%20breath">Stinky coffee breath</a></li>
</ul>
</li>
</ul>
</div>
</div>
<p>
<span class="timestamp-wrapper"><span class="timestamp">[2020-11-22 Sun 22:35] </span></span> Imagine you have weekly meetings with other people, and during the week you take notes about items to discuss at each meeting. When the time for a meeting comes, you want to quickly and easily search for all of the items to discuss at the meeting.
</p>
<p>
You've been experimenting with different ways to track such data in Org. You've tried using tags, but some of the names in question conflict with other tags in your data (e.g. someone's named Charles, but you also work with a firm named Charles, Inc., and you'd prefer to continue using the tag <code>Charles</code> for entries about that firm), so you've been using tags like <code>:personNAME:</code>, which seems awkward. You've tried using a <code>:person: NAME</code> property on entries, which has the advantage of not cluttering the tags list, but also the disadvantage of not being readily visible in an outline.
</p>
<p>
So you haven't decided on a long-term solution, but the meetings aren't going to wait&#x2013;you need to search that data now, and you have a mix of both tags and properties in your entries. What you need is to be able to search for all of the entries about Alice (which you've tagged <code>:personAlice:</code>) when you're meeting with her, and all of the entries about Bob (which have the property <code>:person: Bob</code>) when you're meeting with him. What do you do?
</p>
<div id="outline-container-Using%20built-in%20predicates" class="outline-2">
<h2 id="Using%20built-in%20predicates">Using built-in predicates</h2>
<div class="outline-text-2" id="text-Using%20built-in%20predicates">
<p>
You could start by using built-in Org QL predicates to search your data. For example:
</p>
<div class="org-src-container">
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; text-decoration: underline;">org-ql-query</span><span style="color: #3d85b7;"> </span><span style="color: #3d85b7; font-weight: bold;">:select</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">org-get-heading </span><span style="color: #78880e; font-weight: bold;">:no-tags</span><span style="color: #3d85b7;">)</span>
<span style="color: #3d85b7; font-weight: bold;">:from</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">current-buffer</span><span style="color: #3d85b7;">)</span>
<span style="color: #3d85b7; font-weight: bold;">:where</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e; font-weight: bold;">or</span><span style="color: #78880e;"> (</span><span style="color: #3d8b85; text-decoration: underline;">tags</span><span style="color: #3d8b85;"> </span><span style="color: #65bc957591ca;">"personAlice"</span><span style="color: #78880e;">)</span>
<span style="color: #78880e;">(</span><span style="color: #3d8b85; text-decoration: underline;">property</span><span style="color: #3d8b85;"> </span><span style="color: #65bc957591ca;">"person"</span> <span style="color: #65bc957591ca;">"Bob"</span><span style="color: #78880e;">)</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
</pre>
</div>
<ul class="org-ul">
<li>[#A] Loud pet parakeet</li>
<li>[#C] Missing sticky notes</li>
<li>[#C] Dirty dishes in sink</li>
<li>[#A] Stinky coffee breath</li>
</ul>
<p>
That was easy enough, but it's not very&#x2026;semantic. You have to think about the implementation details: Alice uses tags, Bob uses properties, and what if Charlie uses both? It starts to feel complicated, and it's a lot to type out every time. Is there an easier way?
</p>
</div>
</div>
<div id="outline-container-A%20custom%20~%28person%29~%20predicate" class="outline-2">
<h2 id="A%20custom%20~%28person%29~%20predicate">A custom <code>(person)</code> predicate</h2>
<div class="outline-text-2" id="text-A%20custom%20~%28person%29~%20predicate">
<p>
Enter <code>org-ql</code> custom search predicates. Let's start simple, by defining a predicate to search for just the <code>:person:</code> property, one person at a time. The predicate will take one argument, a person's name, and search for that property. It would look like this:
</p>
<div class="org-src-container">
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; font-weight: bold;">org-ql-defpred</span><span style="color: #3d85b7;"> person (</span><span style="color: #78880e;">name</span><span style="color: #3d85b7;">)</span>
<span style="color: #73139976b41e;">"Search for entries with the \"person\" property being NAME."</span>
<span style="color: #3d85b7; font-weight: bold;">:body</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">property</span><span style="color: #78880e;"> </span><span style="color: #921da24c26e6;">"person"</span> <span style="color: #78880e;">name</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
</pre>
</div>
<p>
Now, let's see what results we get for searching this file for entries about Bob:
</p>
<div class="org-src-container">
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; text-decoration: underline;">org-ql-query</span><span style="color: #3d85b7;"> </span><span style="color: #3d85b7; font-weight: bold;">:select</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">org-get-heading </span><span style="color: #78880e; font-weight: bold;">:no-tags</span><span style="color: #3d85b7;">)</span>
<span style="color: #3d85b7; font-weight: bold;">:from</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">current-buffer</span><span style="color: #3d85b7;">)</span>
<span style="color: #3d85b7; font-weight: bold;">:where</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">person </span><span style="color: #921da24c26e6;">"Bob"</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
</pre>
</div>
<ul class="org-ul">
<li>[#C] Missing sticky notes</li>
<li>[#C] Dirty dishes in sink</li>
<li>[#A] Stinky coffee breath</li>
</ul>
<p>
Hmm, looks like we need to remind Bob to wash his mug and take some mints after lunch. Now what do we need to discuss with Alice?
</p>
<div class="org-src-container">
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; text-decoration: underline;">org-ql-query</span><span style="color: #3d85b7;"> </span><span style="color: #3d85b7; font-weight: bold;">:select</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">org-get-heading </span><span style="color: #78880e; font-weight: bold;">:no-tags</span><span style="color: #3d85b7;">)</span>
<span style="color: #3d85b7; font-weight: bold;">:from</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">current-buffer</span><span style="color: #3d85b7;">)</span>
<span style="color: #3d85b7; font-weight: bold;">:where</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">person </span><span style="color: #921da24c26e6;">"Alice"</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
</pre>
</div>
<pre class="example">
</pre>
<p>
Nothing? Oh, right, Alice's entries use the <code>:personAlice:</code> tag, so we'll also need to search those kind of entries. Let's make the predicate do that, too:
</p>
<div class="org-src-container">
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; font-weight: bold;">org-ql-defpred</span><span style="color: #3d85b7;"> person (</span><span style="color: #78880e;">name</span><span style="color: #3d85b7;">)</span>
<span style="color: #73139976b41e;">"Search for entries with the \"person\" property being NAME or having the tag \"personNAME\"."</span>
<span style="color: #3d85b7; font-weight: bold;">:body</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; font-weight: bold;">or</span><span style="color: #78880e;"> (</span><span style="color: #3d8b85; text-decoration: underline;">property</span><span style="color: #3d8b85;"> </span><span style="color: #65bc957591ca;">"person"</span> <span style="color: #3d8b85;">name</span><span style="color: #78880e;">)</span>
<span style="color: #78880e;">(</span><span style="color: #3d8b85; text-decoration: underline;">tags</span><span style="color: #3d8b85;"> (</span><span style="color: #a17e11; text-decoration: underline;">concat</span><span style="color: #a17e11;"> </span><span style="color: #b86396762cce;">"person"</span> <span style="color: #a17e11;">name</span><span style="color: #3d8b85;">)</span><span style="color: #78880e;">)</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
</pre>
</div>
<p>
How about now?
</p>
<div class="org-src-container">
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; text-decoration: underline;">org-ql-query</span><span style="color: #3d85b7;"> </span><span style="color: #3d85b7; font-weight: bold;">:select</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">org-get-heading </span><span style="color: #78880e; font-weight: bold;">:no-tags</span><span style="color: #3d85b7;">)</span>
<span style="color: #3d85b7; font-weight: bold;">:from</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">current-buffer</span><span style="color: #3d85b7;">)</span>
<span style="color: #3d85b7; font-weight: bold;">:where</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">person </span><span style="color: #921da24c26e6;">"Alice"</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
</pre>
</div>
<ul class="org-ul">
<li>[#A] Loud pet parakeet</li>
<li>[#C] Missing sticky notes</li>
<li>[#C] Dirty dishes in sink</li>
</ul>
<p>
Hmm, I thought we already told her to leave Polly at home.
</p>
</div>
</div>
<div id="outline-container-Searching%20for%20multiple%20people%20at%20once" class="outline-2">
<h2 id="Searching%20for%20multiple%20people%20at%20once">Searching for multiple people at once</h2>
<div class="outline-text-2" id="text-Searching%20for%20multiple%20people%20at%20once">
<p>
Oh, wait, this week is shortened due to holidays, so we're having a combined meeting. How do we search for entries about either of them? Well, this is the obvious solution:
</p>
<div class="org-src-container">
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; text-decoration: underline;">org-ql-query</span><span style="color: #3d85b7;"> </span><span style="color: #3d85b7; font-weight: bold;">:select</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">org-get-heading </span><span style="color: #78880e; font-weight: bold;">:no-tags</span><span style="color: #3d85b7;">)</span>
<span style="color: #3d85b7; font-weight: bold;">:from</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">current-buffer</span><span style="color: #3d85b7;">)</span>
<span style="color: #3d85b7; font-weight: bold;">:where</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e; font-weight: bold;">or</span><span style="color: #78880e;"> (</span><span style="color: #3d8b85;">person </span><span style="color: #65bc957591ca;">"Alice"</span><span style="color: #78880e;">)</span>
<span style="color: #78880e;">(</span><span style="color: #3d8b85;">person </span><span style="color: #65bc957591ca;">"Bob"</span><span style="color: #78880e;">)</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
</pre>
</div>
<ul class="org-ul">
<li>[#A] Loud pet parakeet</li>
<li>[#C] Missing sticky notes</li>
<li>[#C] Dirty dishes in sink</li>
<li>[#A] Stinky coffee breath</li>
</ul>
<p>
And that works fine. But it seems like a lot to type. Could we make the <code>person</code> predicate accept multiple names instead?
</p>
<div class="org-src-container">
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; font-weight: bold;">org-ql-defpred</span><span style="color: #3d85b7;"> person (</span><span style="color: #78880e;">&amp;rest</span><span style="color: #78880e;"> names</span><span style="color: #3d85b7;">)</span>
<span style="color: #73139976b41e;">"Search for entries about any of NAMES."</span>
<span style="color: #3d85b7; font-weight: bold;">:body</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; font-weight: bold;">cl-loop</span><span style="color: #78880e;"> for name in names</span>
<span style="color: #78880e;"> thereis (</span><span style="color: #3d8b85; font-weight: bold;">or</span><span style="color: #3d8b85;"> (</span><span style="color: #a17e11; text-decoration: underline;">property</span><span style="color: #a17e11;"> </span><span style="color: #b86396762cce;">"person"</span> <span style="color: #a17e11;">name</span><span style="color: #3d8b85;">)</span>
<span style="color: #3d8b85;">(</span><span style="color: #a17e11; text-decoration: underline;">tags</span><span style="color: #a17e11;"> (</span><span style="color: #3d85b7; text-decoration: underline;">concat</span><span style="color: #3d85b7;"> </span><span style="color: #73139976b41e;">"person"</span> <span style="color: #3d85b7;">name</span><span style="color: #a17e11;">)</span><span style="color: #3d8b85;">)</span><span style="color: #78880e;">)</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
</pre>
</div>
<p>
Now let's search again:
</p>
<div class="org-src-container">
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; text-decoration: underline;">org-ql-query</span><span style="color: #3d85b7;"> </span><span style="color: #3d85b7; font-weight: bold;">:select</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">org-get-heading </span><span style="color: #78880e; font-weight: bold;">:no-tags</span><span style="color: #3d85b7;">)</span>
<span style="color: #3d85b7; font-weight: bold;">:from</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">current-buffer</span><span style="color: #3d85b7;">)</span>
<span style="color: #3d85b7; font-weight: bold;">:where</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">person </span><span style="color: #921da24c26e6;">"Alice"</span> <span style="color: #921da24c26e6;">"Bob"</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
</pre>
</div>
<ul class="org-ul">
<li>[#A] Loud pet parakeet</li>
<li>[#C] Missing sticky notes</li>
<li>[#C] Dirty dishes in sink</li>
<li>[#A] Stinky coffee breath</li>
</ul>
<p>
That was easy!
</p>
</div>
</div>
<div id="outline-container-Normalizing%20queries%20to%20rewrite%20arguments" class="outline-2">
<h2 id="Normalizing%20queries%20to%20rewrite%20arguments">Normalizing queries to rewrite arguments</h2>
<div class="outline-text-2" id="text-Normalizing%20queries%20to%20rewrite%20arguments">
<p>
Now, all this is well and good if you don't have hundreds of thousands of Org entries in your files. But what if you do? All that <code>concat</code>'ing happening on every entry could add up, and the query might take a few seconds. What if we could do that stringing-along just once, before running the query? We want to turn our <code>(person "Alice" "Bob")</code> query into this, with the <code>:personNAME:</code> strings already made and the per-person <code>(property ...)</code> predicates also included:
</p>
<div class="org-src-container">
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; font-weight: bold;">or</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">tags</span><span style="color: #78880e;"> </span><span style="color: #921da24c26e6;">"personAlice"</span> <span style="color: #921da24c26e6;">"personBob"</span><span style="color: #3d85b7;">)</span>
<span style="color: #3d85b7;">(</span><span style="color: #78880e; text-decoration: underline;">property</span><span style="color: #78880e;"> </span><span style="color: #921da24c26e6;">"person"</span> <span style="color: #921da24c26e6;">"Alice"</span><span style="color: #3d85b7;">)</span>
<span style="color: #3d85b7;">(</span><span style="color: #78880e; text-decoration: underline;">property</span><span style="color: #78880e;"> </span><span style="color: #921da24c26e6;">"person"</span> <span style="color: #921da24c26e6;">"Bob"</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
</pre>
</div>
<p>
Can we do that? In fact, we can, by using a query normalizer. Normalizers are <code>pcase</code> forms (I <i>know</i>) that normalize query expressions before execution. We can use one to rewrite the query ahead of time, like this:
</p>
<div class="org-src-container">
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; font-weight: bold;">org-ql-defpred</span><span style="color: #3d85b7;"> person (</span><span style="color: #78880e;">&amp;rest</span><span style="color: #78880e;"> names</span><span style="color: #3d85b7;">)</span>
<span style="color: #73139976b41e;">"Search for entries about any of NAMES."</span>
<span style="color: #3d85b7; font-weight: bold;">:normalizers</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e;">(</span><span style="color: #3d8b85;">`(</span><span style="color: #a17e11;">person . ,names</span><span style="color: #3d8b85;">)</span>
<span style="color: #3d8b85;">`(</span><span style="color: #a17e11; font-weight: bold;">or</span><span style="color: #a17e11;"> (</span><span style="color: #3d85b7; text-decoration: underline;">tags</span><span style="color: #3d85b7;"> ,@(</span><span style="color: #78880e; font-weight: bold;">cl-loop</span><span style="color: #78880e;"> for name in names</span>
<span style="color: #78880e;"> collect (</span><span style="color: #3d8b85; text-decoration: underline;">concat</span><span style="color: #3d8b85;"> </span><span style="color: #65bc957591ca;">"person"</span> <span style="color: #3d8b85;">name</span><span style="color: #78880e;">)</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
<span style="color: #a17e11;">,@(</span><span style="color: #3d85b7; font-weight: bold;">cl-loop</span><span style="color: #3d85b7;"> for name in names</span>
<span style="color: #3d85b7;"> collect `(</span><span style="color: #78880e;">property </span><span style="color: #921da24c26e6;">"person"</span> <span style="color: #78880e;">,name</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span><span style="color: #3d8b85;">)</span><span style="color: #78880e;">)</span><span style="color: #3d85b7;">)</span>
<span style="color: #3d85b7; font-weight: bold;">:body</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; font-weight: bold;">cl-loop</span><span style="color: #78880e;"> for name in names</span>
<span style="color: #78880e;"> thereis (</span><span style="color: #3d8b85; font-weight: bold;">or</span><span style="color: #3d8b85;"> (</span><span style="color: #a17e11; text-decoration: underline;">property</span><span style="color: #a17e11;"> </span><span style="color: #b86396762cce;">"person"</span> <span style="color: #a17e11;">name</span><span style="color: #3d8b85;">)</span>
<span style="color: #3d8b85;">(</span><span style="color: #a17e11; text-decoration: underline;">tags</span><span style="color: #a17e11;"> name</span><span style="color: #3d8b85;">)</span><span style="color: #78880e;">)</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
</pre>
</div>
<p>
Now, don't faint from all the backquoting and unquoting&#x2013;it's just Lisp, nothing to be afraid of! Let's slow down a moment and see what the normalized query looks like to be sure we're doing it correctly:
</p>
<div class="org-src-container">
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; text-decoration: underline;">org-ql--normalize-query</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">person </span><span style="color: #921da24c26e6;">"Alice"</span> <span style="color: #921da24c26e6;">"Bob"</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
</pre>
</div>
<div class="org-src-container">
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; font-weight: bold;">or</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">tags</span><span style="color: #78880e;"> </span><span style="color: #921da24c26e6;">"personAlice"</span> <span style="color: #921da24c26e6;">"personBob"</span><span style="color: #3d85b7;">)</span>
<span style="color: #3d85b7;">(</span><span style="color: #78880e; text-decoration: underline;">property</span><span style="color: #78880e;"> </span><span style="color: #921da24c26e6;">"person"</span> <span style="color: #921da24c26e6;">"Alice"</span><span style="color: #3d85b7;">)</span>
<span style="color: #3d85b7;">(</span><span style="color: #78880e; text-decoration: underline;">property</span><span style="color: #78880e;"> </span><span style="color: #921da24c26e6;">"person"</span> <span style="color: #921da24c26e6;">"Bob"</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
</pre>
</div>
<p>
And, as they say, Bob's your uncle! Or even if he isn't, let's see if it works:
</p>
<div class="org-src-container">
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; text-decoration: underline;">org-ql-query</span><span style="color: #3d85b7;"> </span><span style="color: #3d85b7; font-weight: bold;">:select</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">org-get-heading </span><span style="color: #78880e; font-weight: bold;">:no-tags</span><span style="color: #3d85b7;">)</span>
<span style="color: #3d85b7; font-weight: bold;">:from</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">current-buffer</span><span style="color: #3d85b7;">)</span>
<span style="color: #3d85b7; font-weight: bold;">:where</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">person </span><span style="color: #921da24c26e6;">"Alice"</span> <span style="color: #921da24c26e6;">"Bob"</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
</pre>
</div>
<ul class="org-ul">
<li>[#A] Loud pet parakeet</li>
<li>[#C] Missing sticky notes</li>
<li>[#C] Dirty dishes in sink</li>
<li>[#A] Stinky coffee breath</li>
</ul>
<p>
Yep, same result as the non-normalized query. And look at how much simpler it is to write <code>(person "Alice" "Bob")</code> than to write <code>(or (tags "personAlice" "personBob") (property "person" "Alice") (property "person" "Bob"))</code>.
</p>
</div>
</div>
<div id="outline-container-Non-sexp%20query%20syntax" class="outline-2">
<h2 id="Non-sexp%20query%20syntax">Non-sexp query syntax</h2>
<div class="outline-text-2" id="text-Non-sexp%20query%20syntax">
<p>
But wait, that's not all! If you order now, we'll throw in non-sexp query syntax for free! That's right, your search could be as simple as typing <code>person:Alice,Bob</code>!
</p>
<div class="org-src-container">
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; text-decoration: underline;">org-ql-search</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">current-buffer</span><span style="color: #3d85b7;">)</span> <span style="color: #73139976b41e;">"person:Alice,Bob"</span><span style="color: #a17e11;">)</span>
</pre>
</div>
<p>
Don't believe me? Well, you see, queries in this syntax are converted to the sexp syntax, like:
</p>
<div class="org-src-container">
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; text-decoration: underline;">org-ql--query-string-to-sexp</span><span style="color: #3d85b7;"> </span><span style="color: #73139976b41e;">"person:Alice,Bob"</span><span style="color: #a17e11;">)</span>
</pre>
</div>
<div class="org-src-container">
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7;">person </span><span style="color: #73139976b41e;">"Alice"</span> <span style="color: #73139976b41e;">"Bob"</span><span style="color: #a17e11;">)</span>
</pre>
</div>
<p>
And that happens automatically when you use a search command like <code>org-ql-search</code>. If you have <code>org-ql</code> installed already, you could even click this link: <a href="person:Alice,Bob">Alice or Bob</a>. Which, in Org syntax, looks like:
</p>
<div class="org-src-container">
<pre class="src src-org"><span style="color: #b58900; text-decoration: underline;"><a href="org-ql-search:person:Alice,Bob">org-ql-search:person:Alice,Bob</a></span>
</pre>
</div>
<p>
And that would open an Agenda Mode buffer that looks like this:
</p>
<pre class="example">
Query: (person "Alice" "Bob") In:meetings.org
[#A] Loud pet parakeet :personAlice:
[#C] Missing sticky notes :personAlice:
[#C] Dirty dishes in sink :personAlice:
[#A] Stinky coffee breath
</pre>
</div>
</div>
<div id="outline-container-Using%20multiple%20predicates" class="outline-2">
<h2 id="Using%20multiple%20predicates">Using multiple predicates</h2>
<div class="outline-text-2" id="text-Using%20multiple%20predicates">
<p>
Oops, you forgot that there's a birthday party in 20 minutes, so you only have time to talk about the highest priority items at this joint meeting today.
</p>
<p>
No problem, let's just select high-priority items:
</p>
<div class="org-src-container">
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; text-decoration: underline;">org-ql-search</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">current-buffer</span><span style="color: #3d85b7;">)</span> <span style="color: #73139976b41e;">"person:Alice,Bob priority:A"</span><span style="color: #a17e11;">)</span>
</pre>
</div>
<p>
Which shows:
</p>
<pre class="example">
Query: (and (person "Alice" "Bob") (priority "A")) In:meetings.org
[#A] Loud pet parakeet :personAlice:
[#A] Stinky coffee breath
</pre>
</div>
</div>
<div id="outline-container-Predicate%20aliases" class="outline-2">
<h2 id="Predicate%20aliases">Predicate aliases</h2>
<div class="outline-text-2" id="text-Predicate%20aliases">
<p>
And, you know what, if you're just so busy that you don't even have time to type the word <code>person</code>, you can add an abbreviated alias, <code>p</code>, like this:
</p>
<div class="org-src-container">
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; font-weight: bold;">org-ql-defpred</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e;">person p</span><span style="color: #3d85b7;">)</span> <span style="color: #3d85b7;">(</span><span style="color: #78880e;">&amp;rest</span><span style="color: #78880e;"> names</span><span style="color: #3d85b7;">)</span>
<span style="color: #73139976b41e;">"Search for entries about any of NAMES."</span>
<span style="color: #3d85b7; font-weight: bold;">:normalizers</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e;">(</span><span style="color: #3d8b85;">`(</span><span style="color: #a17e11;">,predicate-names . ,names</span><span style="color: #3d8b85;">)</span>
<span style="color: #3d8b85;">`(</span><span style="color: #a17e11; font-weight: bold;">or</span><span style="color: #a17e11;"> (</span><span style="color: #3d85b7; text-decoration: underline;">tags</span><span style="color: #3d85b7;"> ,@(</span><span style="color: #78880e; font-weight: bold;">cl-loop</span><span style="color: #78880e;"> for name in names</span>
<span style="color: #78880e;"> collect (</span><span style="color: #3d8b85; text-decoration: underline;">concat</span><span style="color: #3d8b85;"> </span><span style="color: #65bc957591ca;">"person"</span> <span style="color: #3d8b85;">name</span><span style="color: #78880e;">)</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
<span style="color: #a17e11;">,@(</span><span style="color: #3d85b7; font-weight: bold;">cl-loop</span><span style="color: #3d85b7;"> for name in names</span>
<span style="color: #3d85b7;"> collect `(</span><span style="color: #78880e;">property </span><span style="color: #921da24c26e6;">"person"</span> <span style="color: #78880e;">,name</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span><span style="color: #3d8b85;">)</span><span style="color: #78880e;">)</span><span style="color: #3d85b7;">)</span>
<span style="color: #3d85b7; font-weight: bold;">:body</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; font-weight: bold;">cl-loop</span><span style="color: #78880e;"> for name in names</span>
<span style="color: #78880e;"> thereis (</span><span style="color: #3d8b85; font-weight: bold;">or</span><span style="color: #3d8b85;"> (</span><span style="color: #a17e11; text-decoration: underline;">property</span><span style="color: #a17e11;"> </span><span style="color: #b86396762cce;">"person"</span> <span style="color: #a17e11;">name</span><span style="color: #3d8b85;">)</span>
<span style="color: #3d8b85;">(</span><span style="color: #a17e11; text-decoration: underline;">tags</span><span style="color: #a17e11;"> (</span><span style="color: #3d85b7; text-decoration: underline;">concat</span><span style="color: #3d85b7;"> </span><span style="color: #73139976b41e;">"person"</span> <span style="color: #3d85b7;">name</span><span style="color: #a17e11;">)</span><span style="color: #3d8b85;">)</span><span style="color: #78880e;">)</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
</pre>
</div>
<p>
Let's try it:
</p>
<div class="org-src-container">
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; text-decoration: underline;">org-ql-search</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">current-buffer</span><span style="color: #3d85b7;">)</span> <span style="color: #73139976b41e;">"p:Alice,Bob priority:A"</span><span style="color: #a17e11;">)</span>
</pre>
</div>
<p>
And that shows:
</p>
<pre class="example">
Query: (and (person "Alice" "Bob") (priority "A")) In:meetings.org
[#A] Loud pet parakeet :personAlice:
[#A] Stinky coffee breath
</pre>
<p>
(It's up to you to remember whether <code>p</code> means <code>person</code> or <code>priority</code>, but code can't solve everything.)
</p>
</div>
</div>
<div id="outline-container-Be%20formless" class="outline-2">
<h2 id="Be%20formless">Be formless</h2>
<div class="outline-text-2" id="text-Be%20formless">
<p>
We can even go a step further: since the normalizer rewrites the query to call the <code>property</code> and <code>tags</code> predicates instead, this <code>person</code> predicate doesn't even need a body form!
</p>
<div class="org-src-container">
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; font-weight: bold;">org-ql-defpred</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e;">person p</span><span style="color: #3d85b7;">)</span> <span style="color: #3d85b7;">(</span><span style="color: #78880e;">&amp;rest</span><span style="color: #78880e;"> names</span><span style="color: #3d85b7;">)</span>
<span style="color: #73139976b41e;">"Search for entries about any of NAMES."</span>
<span style="color: #3d85b7; font-weight: bold;">:normalizers</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e;">(</span><span style="color: #3d8b85;">`(</span><span style="color: #a17e11;">,predicate-names . ,names</span><span style="color: #3d8b85;">)</span>
<span style="color: #3d8b85;">`(</span><span style="color: #a17e11; font-weight: bold;">or</span><span style="color: #a17e11;"> (</span><span style="color: #3d85b7; text-decoration: underline;">tags</span><span style="color: #3d85b7;"> ,@(</span><span style="color: #78880e; font-weight: bold;">cl-loop</span><span style="color: #78880e;"> for name in names</span>
<span style="color: #78880e;"> collect (</span><span style="color: #3d8b85; text-decoration: underline;">concat</span><span style="color: #3d8b85;"> </span><span style="color: #65bc957591ca;">"person"</span> <span style="color: #3d8b85;">name</span><span style="color: #78880e;">)</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
<span style="color: #a17e11;">,@(</span><span style="color: #3d85b7; font-weight: bold;">cl-loop</span><span style="color: #3d85b7;"> for name in names</span>
<span style="color: #3d85b7;"> collect `(</span><span style="color: #78880e;">property </span><span style="color: #921da24c26e6;">"person"</span> <span style="color: #78880e;">,name</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span><span style="color: #3d8b85;">)</span><span style="color: #78880e;">)</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
</pre>
</div>
<p>
Will it still work?
</p>
<div class="org-src-container">
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; text-decoration: underline;">org-ql-query</span><span style="color: #3d85b7;"> </span><span style="color: #3d85b7; font-weight: bold;">:select</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">org-get-heading </span><span style="color: #78880e; font-weight: bold;">:no-tags</span><span style="color: #3d85b7;">)</span>
<span style="color: #3d85b7; font-weight: bold;">:from</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">current-buffer</span><span style="color: #3d85b7;">)</span>
<span style="color: #3d85b7; font-weight: bold;">:where</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">person </span><span style="color: #921da24c26e6;">"Alice"</span> <span style="color: #921da24c26e6;">"Bob"</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
</pre>
</div>
<ul class="org-ul">
<li>[#A] Loud pet parakeet</li>
<li>[#C] Missing sticky notes</li>
<li>[#C] Dirty dishes in sink</li>
<li>[#A] Stinky coffee breath</li>
</ul>
<p>
It does!
</p>
</div>
</div>
<div id="outline-container-Conclusion" class="outline-2">
<h2 id="Conclusion">Conclusion</h2>
<div class="outline-text-2" id="text-Conclusion">
<p>
In this tutorial, we've gone from having to write lengthy, complex query expressions for accommodating idiosyncratic requirements, to being able to write simple query expressions that abstract away ugly details, to rewriting those query expressions into a more optimal form before a search is even run. The end result is an Org Query Language that is customized to meet your specific needs.
</p>
<p>
What new custom predicates will you write next?
</p>
</div>
</div>
<div id="outline-container-Appendix%3A%20Anaphoric%20macros" class="outline-2">
<h2 id="Appendix%3A%20Anaphoric%20macros">Appendix: Anaphoric macros</h2>
<div class="outline-text-2" id="text-Appendix%3A%20Anaphoric%20macros">
<p>
Finally, if you're a Lisper who appreciates anaphora, you might prefer a more syntactically concise definition of the predicate using Dash macros:
</p>
<div class="org-src-container">
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; font-weight: bold;">org-ql-defpred</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e;">person p</span><span style="color: #3d85b7;">)</span> <span style="color: #3d85b7;">(</span><span style="color: #78880e;">&amp;rest</span><span style="color: #78880e;"> names</span><span style="color: #3d85b7;">)</span>
<span style="color: #73139976b41e;">"Search for entries about any of NAMES."</span>
<span style="color: #3d85b7; font-weight: bold;">:normalizers</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e;">(</span><span style="color: #3d8b85;">`(</span><span style="color: #a17e11;">,predicate-names . ,names</span><span style="color: #3d8b85;">)</span>
<span style="color: #3d8b85;">`(</span><span style="color: #a17e11; font-weight: bold;">or</span><span style="color: #a17e11;"> (</span><span style="color: #3d85b7; text-decoration: underline;">tags</span><span style="color: #3d85b7;"> ,@(</span><span style="color: #78880e; font-weight: bold;">--map</span><span style="color: #78880e;"> `(</span><span style="color: #3d8b85;">concat </span><span style="color: #65bc957591ca;">"person"</span> <span style="color: #3d8b85;">,</span><span style="color: #3d8b85;">it</span><span style="color: #78880e;">)</span> <span style="color: #78880e;">names</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
<span style="color: #a17e11;">,@(</span><span style="color: #3d85b7; font-weight: bold;">--map</span><span style="color: #3d85b7;"> `(</span><span style="color: #78880e;">property </span><span style="color: #921da24c26e6;">"person"</span> <span style="color: #78880e;">,</span><span style="color: #78880e;">it</span><span style="color: #3d85b7;">)</span> <span style="color: #3d85b7;">names</span><span style="color: #a17e11;">)</span><span style="color: #3d8b85;">)</span><span style="color: #78880e;">)</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
</pre>
</div>
<p>
Let's make sure it works:
</p>
<div class="org-src-container">
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; text-decoration: underline;">org-ql-query</span><span style="color: #3d85b7;"> </span><span style="color: #3d85b7; font-weight: bold;">:select</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">org-get-heading </span><span style="color: #78880e; font-weight: bold;">:no-tags</span><span style="color: #3d85b7;">)</span>
<span style="color: #3d85b7; font-weight: bold;">:from</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">current-buffer</span><span style="color: #3d85b7;">)</span>
<span style="color: #3d85b7; font-weight: bold;">:where</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">person </span><span style="color: #921da24c26e6;">"Alice"</span> <span style="color: #921da24c26e6;">"Bob"</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
</pre>
</div>
<ul class="org-ul">
<li>[#A] Loud pet parakeet</li>
<li>[#C] Missing sticky notes</li>
<li>[#C] Dirty dishes in sink</li>
<li>[#A] Stinky coffee breath</li>
</ul>
<p>
Lisp is fun!
</p>
</div>
</div>
<div id="outline-container-Example%20data" class="outline-2">
<h2 id="Example%20data">Example data</h2>
<div class="outline-text-2" id="text-Example%20data">
</div>
<div id="outline-container-Loud%20pet%20parakeet" class="outline-3">
<h3 id="Loud%20pet%20parakeet">Loud pet parakeet&#xa0;&#xa0;&#xa0;<span class="tag"><span class="personAlice">personAlice</span></span></h3>
</div>
<div id="outline-container-Missing%20sticky%20notes" class="outline-3">
<h3 id="Missing%20sticky%20notes">Missing sticky notes&#xa0;&#xa0;&#xa0;<span class="tag"><span class="personAlice">personAlice</span></span></h3>
<div class="outline-text-3" id="text-Missing%20sticky%20notes">
</div>
</div>
<div id="outline-container-Dirty%20dishes%20in%20sink" class="outline-3">
<h3 id="Dirty%20dishes%20in%20sink">Dirty dishes in sink&#xa0;&#xa0;&#xa0;<span class="tag"><span class="personAlice">personAlice</span></span></h3>
<div class="outline-text-3" id="text-Dirty%20dishes%20in%20sink">
</div>
</div>
<div id="outline-container-Stinky%20coffee%20breath" class="outline-3">
<h3 id="Stinky%20coffee%20breath">Stinky coffee breath</h3>
<div class="outline-text-3" id="text-Stinky%20coffee%20breath">
</div>
</div>
</div>
</div>
<div id="postamble" class="status">
<p class="date">Created: 2020-11-23 Mon 03:31</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>
</html>

13
examples/defpred.org
View file

@ -1,5 +1,6 @@
#+TITLE: Org QL Custom Predicates Tutorial #+TITLE: Org QL Custom Predicates Tutorial
#+OPTIONS: author:nil creator:nil created:nil date:nil num:nil title:t #+OPTIONS: author:nil creator:nil created:nil date:nil num:nil title:t broken-links:t
#+SETUPFILE: export/setup/theme-darksun-local.setup
[2020-11-22 Sun 22:35] Imagine you have weekly meetings with other people, and during the week you take notes about items to discuss at each meeting. When the time for a meeting comes, you want to quickly and easily search for all of the items to discuss at the meeting. [2020-11-22 Sun 22:35] Imagine you have weekly meetings with other people, and during the week you take notes about items to discuss at each meeting. When the time for a meeting comes, you want to quickly and easily search for all of the items to discuss at the meeting.
@ -7,7 +8,7 @@ You've been experimenting with different ways to track such data in Org. You've
So you haven't decided on a long-term solution, but the meetings aren't going to wait--you need to search that data now, and you have a mix of both tags and properties in your entries. What you need is to be able to search for all of the entries about Alice (which you've tagged ~:personAlice:~) when you're meeting with her, and all of the entries about Bob (which have the property ~:person: Bob~) when you're meeting with him. What do you do? So you haven't decided on a long-term solution, but the meetings aren't going to wait--you need to search that data now, and you have a mix of both tags and properties in your entries. What you need is to be able to search for all of the entries about Alice (which you've tagged ~:personAlice:~) when you're meeting with her, and all of the entries about Bob (which have the property ~:person: Bob~) when you're meeting with him. What do you do?
* Contents * Contents :noexport:
:PROPERTIES: :PROPERTIES:
:TOC: :include siblings :ignore this :TOC: :include siblings :ignore this
:END: :END:
@ -130,6 +131,8 @@ And that works fine. But it seems like a lot to type. Could we make the =perso
(tags (concat "person" name))))) (tags (concat "person" name)))))
#+END_SRC #+END_SRC
Now let's search again:
#+BEGIN_SRC elisp :results list :exports both :cache yes #+BEGIN_SRC elisp :results list :exports both :cache yes
(org-ql-query :select '(org-get-heading :no-tags) (org-ql-query :select '(org-get-heading :no-tags)
:from (current-buffer) :from (current-buffer)
@ -243,6 +246,8 @@ No problem, let's just select high-priority items:
(org-ql-search (current-buffer) "person:Alice,Bob priority:A") (org-ql-search (current-buffer) "person:Alice,Bob priority:A")
#+END_SRC #+END_SRC
Which shows:
#+BEGIN_EXAMPLE #+BEGIN_EXAMPLE
Query: (and (person "Alice" "Bob") (priority "A")) In:meetings.org Query: (and (person "Alice" "Bob") (priority "A")) In:meetings.org
[#A] Loud pet parakeet :personAlice: [#A] Loud pet parakeet :personAlice:
@ -266,10 +271,14 @@ And, you know what, if you're just so busy that you don't even have time to type
(tags (concat "person" name))))) (tags (concat "person" name)))))
#+END_SRC #+END_SRC
Let's try it:
#+BEGIN_SRC elisp :results silent :exports code #+BEGIN_SRC elisp :results silent :exports code
(org-ql-search (current-buffer) "p:Alice,Bob priority:A") (org-ql-search (current-buffer) "p:Alice,Bob priority:A")
#+END_SRC #+END_SRC
And that shows:
#+BEGIN_EXAMPLE #+BEGIN_EXAMPLE
Query: (and (person "Alice" "Bob") (priority "A")) In:meetings.org Query: (and (person "Alice" "Bob") (priority "A")) In:meetings.org
[#A] Loud pet parakeet :personAlice: [#A] Loud pet parakeet :personAlice:

17
examples/export/setup/theme-darksun-local.setup Normal file
View file

@ -0,0 +1,17 @@
# -*- mode: org; -*-
# The files that hide sections and display a navbar and ToC are commented out.
# #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="export/styles/darksun/css/htmlize.css"/>
#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="export/styles/darksun/css/darksun.css"/>
# #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="export/styles/darksun/css/hideshow.css"/>
#+HTML_HEAD: <script type="text/javascript" src="export/styles/darksun/js/jquery-1.11.0.min.js"></script>
#+HTML_HEAD: <script type="text/javascript" src="export/styles/darksun/js/jquery-ui-1.10.2.min.js"></script>
#+HTML_HEAD: <script type="text/javascript" src="export/styles/darksun/js/jquery.localscroll-min.js"></script>
#+HTML_HEAD: <script type="text/javascript" src="export/styles/darksun/js/jquery.scrollTo-1.4.3.1-min.js"></script>
#+HTML_HEAD: <script type="text/javascript" src="export/styles/darksun/js/jquery.zclip.min.js"></script>
#+HTML_HEAD: <script type="text/javascript" src="export/styles/darksun/js/darksun.js"></script>
# #+HTML_HEAD: <script type="text/javascript" src="export/styles/darksun/js/hideshow.js"></script>
#+HTML_HEAD: <script type="text/javascript" src="export/styles/lib/js/jquery.stickytableheaders.min.js"></script>

15
examples/export/setup/theme-darksun.setup Normal file
View file

@ -0,0 +1,15 @@
# -*- mode: org; -*-
#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="http://www.pirilampo.org/styles/darksun/css/htmlize.css"/>
#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="http://www.pirilampo.org/styles/darksun/css/darksun.css"/>
#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="http://www.pirilampo.org/styles/darksun/css/hideshow.css"/>
#+HTML_HEAD: <script type="text/javascript" src="http://www.pirilampo.org/styles/darksun/js/jquery-1.11.0.min.js"></script>
#+HTML_HEAD: <script type="text/javascript" src="http://www.pirilampo.org/styles/darksun/js/jquery-ui-1.10.2.min.js"></script>
#+HTML_HEAD: <script type="text/javascript" src="http://www.pirilampo.org/styles/darksun/js/jquery.localscroll-min.js"></script>
#+HTML_HEAD: <script type="text/javascript" src="http://www.pirilampo.org/styles/darksun/js/jquery.scrollTo-1.4.3.1-min.js"></script>
#+HTML_HEAD: <script type="text/javascript" src="http://www.pirilampo.org/styles/darksun/js/jquery.zclip.min.js"></script>
#+HTML_HEAD: <script type="text/javascript" src="http://www.pirilampo.org/styles/darksun/js/darksun.js"></script>
#+HTML_HEAD: <script type="text/javascript" src="http://www.pirilampo.org/styles/darksun/js/hideshow.js"></script>
#+HTML_HEAD: <script type="text/javascript" src="http://www.pirilampo.org/styles/lib/js/jquery.stickytableheaders.min.js"></script>

264
examples/export/styles/darksun/css/darksun.css Normal file
View file

@ -0,0 +1,264 @@
* {
border-color: #657b83;
}
a {
color: #268bd2 !important;
}
a:visited {
color: #6c71c4 !important;
}
body {
background-color: #002b36 !important;
color: #839496 !important;
font-family: Libre Baskerville, serif;
}
html {
background-color: #002b36 !important;
}
input,
textarea {
background-color: #073642 !important;
color: #839496 !important;
}
blockquote,
code,
pre {
background-color: #073642 !important;
border: 1px solid #094352 !important;
border-radius: 2px;
box-shadow: none;
color: #839496 !important;
}
code {
font-size: 1.2em;
}
img {
margin: 0.5em;
}
.buttons {
background-color: #073642 !important;
color: #93a1a1 !important;
font-family: sans-serif;
font-size: 1.5rem;
}
.hsReviewPanel {
display: none;
}
.title {
border: 0;
}
#postamble {
display: none;
}
#banner {
text-align: center;
}
#tabs {
background-color: #073642 !important;
float: left;
margin: 0px 0px 20px 0px;
padding: 0;
width: 100%;
font-family: sans-serif;
}
#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 {
display: block;
font-size: 120%;
font-weight: bold;
margin: 0;
padding: 4px 10px 4px 10px;
text-decoration: none;
}
#tabs li a:hover {
color: #90c5eb !important;
}
#tabs li.ui-tabs-active a {
background-color: #094352 !important;
color: #59a9e1 !important;
}
#content {
clear: both;
width: 80%;
}
#content > p {
margin: 1em;
}
#content > div > h2 {
margin: 0.25rem;
}
#postamble {
text-align: right;
}
blockquote {
background-color: #073642 !important;
padding-left: 0.75em;
padding-right: 0.75em;
padding-top: 0.01em;
padding-bottom: 0.01em;
overflow: hidden;
margin-left: 0;
}
.outline-text-2,
.outline-text-3,
.outline-text-4,
.outline-text-5,
.outline-text-6 {
padding-left: 4%;
}
.outline-3 {
padding-left: 4%;
}
.outline-4 {
padding-left: 4%;
}
.outline-5 {
padding-left: 4%;
}
.outline-6 {
padding-left: 4%;
}
h1,
h2,
h3,
h4,
h5,
h6 {
font-family: sans-serif;
border-bottom: 2px solid;
border-color: #094352 !important;
}
a:hover {
text-decoration: underline;
}
#search {
display: block;
float: right;
}
.tag {
background-color: #002b36 !important;
color: #93a1a1 !important;
border: 0px;
}
.tag span {
background-color: #094352 !important;
margin: 0.25em;
padding: 0.25em;
}
#table-of-contents {
display: table;
float: right;
}
#table-of-contents h2 {
display: none;
}
#table-of-contents li {
list-style-type: none;
}
#table-of-contents a:hover {
text-decoration: underline;
}
#minitoc {
background-color: #073642 !important;
position: fixed;
top: 0px;
right: -5px;
padding: 0.5em;
z-index: 200;
width: 18%;
word-wrap: normal;
overflow: hidden;
}
#minitoc ul {
margin: 0.5em;
padding-left: 1em;
}
#minitoc h2 {
margin-top: 0;
margin-bottom: 0;
font-size: 110%;
}
#minitoc a {
display: block;
font-family: sans-serif;
text-decoration: none;
}
#minitoc a:hover {
text-decoration: underline;
}
/* #minitoc a { */
/* display: none; */
/* } */
#minitoc:hover a {
display: block;
}
#toTop {
top: -100px;
position: fixed;
text-align: center;
z-index: 999;
display: none;
}
#toTop:hover {
text-decoration: underline;
}
#left-panel-wrapper {
display: none;
position: fixed;
z-index: 200;
}
#left-panel-contents {
display: none;
position: fixed;
text-align: left;
top: 0;
z-index: 200;
}
#left-panel-button {
transform: rotate(90deg);
left: -23px;
position: fixed;
top: 50%;
z-index: 200;
}
#right-panel-wrapper {
position: fixed;
z-index: 200;
}
#right-panel-contents {
display: none;
z-index: 200;
position: fixed;
text-align: left;
top: 0;
}
.snippet-copy-to-clipboard {
display: none;
position: absolute;
left: 50px;
top: 50px;
}
.org-ol > li,
.org-dl > dt {
margin-top: 0.5em;
}
.org-ul {
margin-top: 1em;
margin-bottom: 1em;
}
.org-ul li {
margin-top: 0.5em;
}
.org-ul > li > a {
font-family: sans-serif;
}

110
examples/export/styles/darksun/css/hideshow.css Normal file
View file

@ -0,0 +1,110 @@
/* 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 {
text-decoration: underline;
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;
}

145
examples/export/styles/darksun/css/htmlize.css Normal file
View 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
examples/export/styles/darksun/images/checked.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 3.1 KiB

BIN
examples/export/styles/darksun/images/fixme.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 625 B

BIN
examples/export/styles/darksun/images/halfchecked.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 3 KiB

BIN
examples/export/styles/darksun/images/info.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 4.3 KiB

BIN
examples/export/styles/darksun/images/note.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 4.5 KiB

BIN
examples/export/styles/darksun/images/tip.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 4.3 KiB

BIN
examples/export/styles/darksun/images/unchecked.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 3 KiB

BIN
examples/export/styles/darksun/images/warning.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 4.2 KiB

524
examples/export/styles/darksun/js/darksun.js Normal file
View file

@ -0,0 +1,524 @@
// darksun.js --- darksun 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-content').empty().append('<h2>In this section</h2><ul></ul>');
$('#' + divId).find('h3').each(function(i) {
// [2018-09-03 Mon 03:48] Get text up to non-breaking space,
// to omit the tags. If there are no tags, there will be no
// &nbsp;, so get all the text. (This fixes a bug in the
// original code.)
let text = null;
let pos = $(this).text().search(/ | ►/);
if (pos > 0) {
text = $(this).text().substring(0, pos);
}
else {
text = $(this).text();
}
$("#minitoc-content>ul").append("<li><a href='#" + $(this).attr("id") + "'>"
+ text + "</a></li>");
});
// Ensure that the target is expanded (hideShow)
$('#minitoc-content 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();
// Initialize hideShow
hsInit();
// 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();
});
// 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 darksun,
// get the path to it (it will be relative to the current page location).
var bbScriptPath = $('script[src$="darksun.js"]').attr('src'); // the js file path
var bbPathToZeroClipboardSwf = bbScriptPath.replace('darksun.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: 'styles/darksun/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 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;

335
examples/export/styles/darksun/js/hideshow.js Normal file
View file

@ -0,0 +1,335 @@
// hideshow.js --- HideShow JS 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
// 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';
}
if (typeof HS_HIDE_ALL_TEXT === 'undefined') {
var HS_HIDE_ALL_TEXT = 'Collapse';
}
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 = '&#x25BA;'; // black right-pointing pointer
}
if (typeof HS_ICON_OPEN === 'undefined') {
var HS_ICON_OPEN = '&#x25BC;'; // black down-pointing triangle
}
if (typeof HS_ICON_EMPTY === 'undefined') {
var HS_ICON_EMPTY = '&#x25A0;'; // 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 div to hold minitoc content (so it can be cleared without deleting the buttons)
$('#minitoc').append($('<div id="minitoc-content"></div>'));
// Add buttons
$('#minitoc').append($('<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>'
+ '</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>'
+ '</div>');
}
});
}
var nbReviewTotalTasks;
$(document).ready(function() {
nbReviewTotalTasks = $('.outline-2 span.todo').length;
hsAddReviewPanels();
});

4
examples/export/styles/darksun/js/jquery-1.11.0.min.js vendored Normal file
View file

File diff suppressed because one or more lines are too long

5
examples/export/styles/darksun/js/jquery-1.9.1.min.js vendored Normal file
View file

File diff suppressed because one or more lines are too long

12
examples/export/styles/darksun/js/jquery-ui-1.10.2.min.js vendored Normal file
View file

File diff suppressed because one or more lines are too long

9
examples/export/styles/darksun/js/jquery.localscroll-min.js vendored Normal file
View 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
examples/export/styles/darksun/js/jquery.scrollTo-1.4.3.1-min.js vendored Normal file
View 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
examples/export/styles/darksun/js/jquery.zclip.min.js vendored Normal file
View file

File diff suppressed because one or more lines are too long

1
examples/export/styles/lib/js/jquery.stickytableheaders.min.js vendored Normal file
View 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
examples/export/styles/lib/js/stickytableheaders-license.txt Normal file
View 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.