Commits

Anonymous committed 86e5a20

neorg-doc/e5405f23d7b7

Comments (0)

Files changed (5)

neorg-doc/_sources/changelog.txt

 v0.0.3
 ^^^^^^
 
+- Pages can be searched from the right top search box.
+- :rst:dir:`table-data-and-image` highlights data with different
+  values.
+- :rst:dir:`list-pages` shows sub-pages as a nested list, not as a
+  flat list.
+- Show sub-pages when the accessed page does not exist but at least
+  one sub-page exists.
 - Use reversed :term:`page path` as a page title.
 
 v0.0.2

neorg-doc/_sources/index.txt

 .. seealso:: :ref:`examples/template-page`
 
 
+Searching Pages
+===============
+
+NEOrg has Whoosh_ powered searching functionality.
+For the full description of the query language, see
+`The default query language --- Whoosh documentation`_.
+The following are quick examples:
+
+.. list-table:: Query examples
+   :header-rows: 1
+   :widths: 1 2
+
+   * - Query
+     - Meaning
+   * - ``alpha AND beta``
+     -
+   * - ``alpha beta``
+     - equivalent to ``alpha AND beta``
+   * - ``alpha NOT (beta OR gamma)``
+     -
+   * - ``page_path:MyPage``
+     - use :term:`page path` in the search query
+   * - ``page_path:(MyPage SubPage)``
+     - equivalent to ``page_path:MyPage page_path:SubPage``
+   * - ``te?t test* *b?g*``
+     - use :term:`unix shell-style pattern matching`
+   * - ``ninja^2 cowboy bear^0.5``
+     - importance: ninja = 2*cowboy = 4*bear
+
+
+.. _`The default query language --- Whoosh documentation`:
+   http://packages.python.org/Whoosh/querylang.html
+.. _Whoosh: https://bitbucket.org/mchaput/whoosh/wiki/Home
+
+
 Glossary
 ========
 
        See `reStructuredText Directives`_ for more information and
        the basic directives defined by docutils.
 
-       NEOrg defines varikous special for displaying and organizing
+       NEOrg defines various special for displaying and organizing
        data effectively (see :ref:`special-directives`).
 
    page path

neorg-doc/changelog.html

 <div class="section" id="v0-0-3">
 <h2>v0.0.3<a class="headerlink" href="#v0-0-3" title="Permalink to this headline">¶</a></h2>
 <ul class="simple">
+<li>Pages can be searched from the right top search box.</li>
+<li><a class="reference internal" href="index.html#directive-table-data-and-image" title="table-data-and-image directive"><tt class="xref rst rst-dir docutils literal"><span class="pre">table-data-and-image</span></tt></a> highlights data with different
+values.</li>
+<li><a class="reference internal" href="index.html#directive-list-pages" title="list-pages directive"><tt class="xref rst rst-dir docutils literal"><span class="pre">list-pages</span></tt></a> shows sub-pages as a nested list, not as a
+flat list.</li>
+<li>Show sub-pages when the accessed page does not exist but at least
+one sub-page exists.</li>
 <li>Use reversed <a class="reference internal" href="index.html#term-page-path"><em class="xref std std-term">page path</em></a> as a page title.</li>
 </ul>
 </div>

neorg-doc/index.html

 </ul>
 </li>
 <li><a class="reference internal" href="#template-page-temp" id="id10">Template page - <tt class="docutils literal"><span class="pre">_temp_</span></tt></a></li>
-<li><a class="reference internal" href="#glossary" id="id11">Glossary</a></li>
-<li><a class="reference internal" href="#configuration-variables" id="id12">Configuration variables</a></li>
-<li><a class="reference internal" href="#faqs" id="id13">FAQs</a><ul>
-<li><a class="reference internal" href="#how-do-i-make-a-new-page" id="id14">How do I make a new page?</a></li>
-<li><a class="reference internal" href="#how-do-i-make-a-link-to-the-other-page" id="id15">How do I make a link to the other page?</a></li>
+<li><a class="reference internal" href="#searching-pages" id="id11">Searching Pages</a></li>
+<li><a class="reference internal" href="#glossary" id="id12">Glossary</a></li>
+<li><a class="reference internal" href="#configuration-variables" id="id13">Configuration variables</a></li>
+<li><a class="reference internal" href="#faqs" id="id14">FAQs</a><ul>
+<li><a class="reference internal" href="#how-do-i-make-a-new-page" id="id15">How do I make a new page?</a></li>
+<li><a class="reference internal" href="#how-do-i-make-a-link-to-the-other-page" id="id16">How do I make a link to the other page?</a></li>
 </ul>
 </li>
-<li><a class="reference internal" href="#docuitils-links" id="id16">Docuitils links</a></li>
-<li><a class="reference internal" href="#other-contents" id="id17">Other contents</a></li>
+<li><a class="reference internal" href="#docuitils-links" id="id17">Docuitils links</a></li>
+<li><a class="reference internal" href="#other-contents" id="id18">Other contents</a></li>
 </ul>
 </li>
 </ul>
 <p class="last"><a class="reference internal" href="examples.html#examples-template-page"><em>Example usages of the template page</em></a></p>
 </div>
 </div>
+<div class="section" id="searching-pages">
+<h2><a class="toc-backref" href="#id11">Searching Pages</a><a class="headerlink" href="#searching-pages" title="Permalink to this headline">¶</a></h2>
+<p>NEOrg has <a class="reference external" href="https://bitbucket.org/mchaput/whoosh/wiki/Home">Whoosh</a> powered searching functionality.
+For the full description of the query language, see
+<a class="reference external" href="http://packages.python.org/Whoosh/querylang.html">The default query language &#8212; Whoosh documentation</a>.
+The following are quick examples:</p>
+<table border="1" class="docutils">
+<caption>Query examples</caption>
+<colgroup>
+<col width="33%" />
+<col width="67%" />
+</colgroup>
+<thead valign="bottom">
+<tr><th class="head">Query</th>
+<th class="head">Meaning</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr><td><tt class="docutils literal"><span class="pre">alpha</span> <span class="pre">AND</span> <span class="pre">beta</span></tt></td>
+<td>&nbsp;</td>
+</tr>
+<tr><td><tt class="docutils literal"><span class="pre">alpha</span> <span class="pre">beta</span></tt></td>
+<td>equivalent to <tt class="docutils literal"><span class="pre">alpha</span> <span class="pre">AND</span> <span class="pre">beta</span></tt></td>
+</tr>
+<tr><td><tt class="docutils literal"><span class="pre">alpha</span> <span class="pre">NOT</span> <span class="pre">(beta</span> <span class="pre">OR</span> <span class="pre">gamma)</span></tt></td>
+<td>&nbsp;</td>
+</tr>
+<tr><td><tt class="docutils literal"><span class="pre">page_path:MyPage</span></tt></td>
+<td>use <a class="reference internal" href="#term-page-path"><em class="xref std std-term">page path</em></a> in the search query</td>
+</tr>
+<tr><td><tt class="docutils literal"><span class="pre">page_path:(MyPage</span> <span class="pre">SubPage)</span></tt></td>
+<td>equivalent to <tt class="docutils literal"><span class="pre">page_path:MyPage</span> <span class="pre">page_path:SubPage</span></tt></td>
+</tr>
+<tr><td><tt class="docutils literal"><span class="pre">te?t</span> <span class="pre">test*</span> <span class="pre">*b?g*</span></tt></td>
+<td>use <a class="reference internal" href="#term-unix-shell-style-pattern-matching"><em class="xref std std-term">unix shell-style pattern matching</em></a></td>
+</tr>
+<tr><td><tt class="docutils literal"><span class="pre">ninja^2</span> <span class="pre">cowboy</span> <span class="pre">bear^0.5</span></tt></td>
+<td>importance: ninja = 2*cowboy = 4*bear</td>
+</tr>
+</tbody>
+</table>
+</div>
 <div class="section" id="glossary">
-<h2><a class="toc-backref" href="#id11">Glossary</a><a class="headerlink" href="#glossary" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id12">Glossary</a><a class="headerlink" href="#glossary" title="Permalink to this headline">¶</a></h2>
 <dl class="glossary docutils">
 <dt id="term-directive">directive</dt>
 <dd><p class="first">A directive is one of the <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> block markup in
 </div>
 <p>See <a class="reference external" href="http://docutils.sourceforge.net/docs/ref/rst/directives.html">reStructuredText Directives</a> for more information and
 the basic directives defined by docutils.</p>
-<p class="last">NEOrg defines varikous special for displaying and organizing
+<p class="last">NEOrg defines various special for displaying and organizing
 data effectively (see <a class="reference internal" href="#special-directives"><em>Special directives</em></a>).</p>
 </dd>
 <dt id="term-page-path">page path</dt>
 </dl>
 </div>
 <div class="section" id="configuration-variables">
-<h2><a class="toc-backref" href="#id12">Configuration variables</a><a class="headerlink" href="#configuration-variables" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id13">Configuration variables</a><a class="headerlink" href="#configuration-variables" title="Permalink to this headline">¶</a></h2>
 <dl class="envvar">
 <dt id="envvar-DATADIRPATH">
 <tt class="descname">DATADIRPATH</tt><a class="headerlink" href="#envvar-DATADIRPATH" title="Permalink to this definition">¶</a></dt>
 
 </div>
 <div class="section" id="faqs">
-<h2><a class="toc-backref" href="#id13">FAQs</a><a class="headerlink" href="#faqs" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id14">FAQs</a><a class="headerlink" href="#faqs" title="Permalink to this headline">¶</a></h2>
 <div class="section" id="how-do-i-make-a-new-page">
-<h3><a class="toc-backref" href="#id14">How do I make a new page?</a><a class="headerlink" href="#how-do-i-make-a-new-page" title="Permalink to this headline">¶</a></h3>
+<h3><a class="toc-backref" href="#id15">How do I make a new page?</a><a class="headerlink" href="#how-do-i-make-a-new-page" title="Permalink to this headline">¶</a></h3>
 <p>Just type a page path to the browser&#8217;s address bar, e.g.:</p>
 <div class="highlight-python"><pre>http://localhost:8000/my/new/page/</pre>
 </div>
 <p>and then you will see the edit form, if the page does not exist.</p>
 </div>
 <div class="section" id="how-do-i-make-a-link-to-the-other-page">
-<h3><a class="toc-backref" href="#id15">How do I make a link to the other page?</a><a class="headerlink" href="#how-do-i-make-a-link-to-the-other-page" title="Permalink to this headline">¶</a></h3>
+<h3><a class="toc-backref" href="#id16">How do I make a link to the other page?</a><a class="headerlink" href="#how-do-i-make-a-link-to-the-other-page" title="Permalink to this headline">¶</a></h3>
 <p>If a string starts with <tt class="docutils literal"><span class="pre">/</span></tt>, <tt class="docutils literal"><span class="pre">./</span></tt> or <tt class="docutils literal"><span class="pre">../</span></tt>, ends with <tt class="docutils literal"><span class="pre">/</span></tt>
 and contains only alphabets, numbers and <tt class="docutils literal"><span class="pre">_.+-`</span></tt> then it will
 be regarded as a link.  For example:</p>
 </div>
 </div>
 <div class="section" id="docuitils-links">
-<h2><a class="toc-backref" href="#id16">Docuitils links</a><a class="headerlink" href="#docuitils-links" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id17">Docuitils links</a><a class="headerlink" href="#docuitils-links" title="Permalink to this headline">¶</a></h2>
 <ul class="simple">
 <li><a class="reference external" href="http://docutils.sourceforge.net/docs/">Docutils Project Documentation Overview</a><ul>
 <li><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a><ul>
 </ul>
 </div>
 <div class="section" id="other-contents">
-<h2><a class="toc-backref" href="#id17">Other contents</a><a class="headerlink" href="#other-contents" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id18">Other contents</a><a class="headerlink" href="#other-contents" title="Permalink to this headline">¶</a></h2>
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Example usages of the special directives</a></li>

neorg-doc/searchindex.js

-Search.setIndex({objects:{"":{dictdiff:[0,1,1],DATABASE:[0,0,1],DATADIRPATH:[0,0,1],"grid-images":[0,1,1],DEBUG:[0,0,1],"table-data-and-image":[0,1,1],"table-data":[0,1,1],"list-pages":[0,1,1],"find-images":[0,1,1]}},terms:{serv:[0,1,3],"default":[0,1],hyper:0,newest:2,help:1,just:0,show:[0,1,3],cheat:0,text:0,untrust:0,sort_r:[0,2],rest:[],syntax:0,shape:0,"3x3":0,comma:0,follow:[0,2],primer:0,vari:[0,2],find:[0,2],paramet:[0,3],web:1,style:0,note:[0,2],varik:0,also:[0,2],flask:0,fix:[0,3],configur:0,specif:0,param:[0,2],should:0,init:[0,1],neorg:[0,1,3],under:[0,2],exit:1,match:0,real:0,applic:0,them:0,ani:0,string:0,get:0,dest:1,faq:0,initi:1,becaus:0,grid:[0,2],insert:0,magic:0,sysmtem:0,name:0,dim:0,docuitil:0,graph_2:2,like:[0,2],organ:[0,1],graph_1:2,edit:[0,3],docutil:0,tran:[0,2],another_opt:0,integ:0,separ:0,did:[0,3],bad:0,mode:[0,1],have:[0,2],contain:0,debug:[0,1],found:2,refer:0,where:[0,1],page:[0,2,3],view:0,unexpectedli:0,set:[0,1],dictdiff:[0,2],seq:0,list:0,creation:3,some:0,direct:[0,2],displai:0,subdata:0,see:[0,2],result:[0,2],arg:[0,2],home:0,happen:0,port:1,special:[0,2],out:0,variabl:0,index:0,what:0,still:3,network:0,compar:2,space:0,support:0,databas:0,user:[0,3],content:[0,2],delet:0,version:[0,3],tail:0,rel:0,"new":0,leftmost:0,experi:[0,2],localhost:0,relpath:[0,2],key2:0,full:0,run:[0,1,3],linear:0,parent:0,numer:1,gener:[0,2],another_paramet:0,usag:[0,1,2],given:0,someon:0,quick:0,base:[0,2],dictionari:0,address:0,releas:3,path:[0,2,3],interpret:0,sub:[0,1],convert:3,revers:[0,3],val:0,column:0,similar:2,anyth:0,alon:1,transpos:0,simul:1,filter:0,etc:3,regular:0,period:0,stand:1,url:0,chang:0,mean:0,produc:2,gamma:2,first:[0,3],slash:0,restructuredtext:0,glossari:0,overview:0,hyphen:0,dimension:0,number:0,systemat:0,werkzeug:0,regrad:0,unix:0,least:0,demonstr:0,diff:2,guid:0,open:1,your:0,kei:0,differ:0,sheet:0,workaround:3,width:[0,2,3],top:2,changelog:[0,3],system:3,messag:[0,1],avail:0,start:[0,1],json:[0,2],datadirpath:[0,2],valu:0,basic:[0,2],type:0,nestedkey2:0,more:0,sort:0,from:0,shell:0,option:[0,1,2],form:0,python:[0,3],imag:[0,2,3],regard:0,search:0,specifi:0,idea:0,warn:0,flag:0,link:[0,2,3],too:3,role:0,"true":[0,1],than:0,png:2,card:0,texsts_with_a:0,onli:0,word:0,target:0,"_temp_":[0,2],replac:[0,2],remov:0,access:[0,2],tree:2,second:0,charact:0,project:0,defin:0,invok:0,paragraph:2,texsts_with_a_:0,can:[0,2,3],assum:2,wild:0,about:0,problem:3,purpos:[0,2],root:[0,1],fetch:0,browser:[0,1],listen:1,sqlite:0,weaker:0,traceback:3,abov:[0,2],ran:0,nestedkey1:0,key1:0,argument:[0,1],templat:[0,2],repres:0,seed:2,exist:[0,1],file:[0,2],tabl:[0,2,3],need:0,doe:0,check:3,repeatedli:0,alwai:0,end:0,newlin:0,want:[0,2],titl:3,make:[0,2],format:0,when:[0,2],detail:0,write:0,how:0,other:0,interact:0,posit:1,which:0,environ:0,you:[0,2],document:0,thu:0,singl:0,higher:0,under_scor:0,relat:0,http:0,webserv:1,clash:[0,3],nest:0,after:0,effect:0,express:0,befor:3,beta:2,scale:2,pattern:0,two:0,mai:[0,2],alpha:2,underscor:0,data:[0,2,3],shown:0,matrix:0,bar:0,"short":3,don:[0,2],equival:0,bug:3,directori:[0,1],markup:0,correspond:0,exclud:[0,2],inform:0,exampl:[0,2],command:[0,1,3],block:0,thi:[0,1,2],alphabet:0,escap:0,everyth:0,order:[0,2],sibl:0,includ:0},objtypes:{"0":"std:envvar","1":"rst:directive"},titles:["NEOrg Reference Guide","NEOrg commands","Example usages of the special directives","ChangeLog"],objnames:{"0":"environment variable","1":"reStructuredText directive"},filenames:["index","commands","examples","changelog"]})
+Search.setIndex({objects:{"":{dictdiff:[0,1,1],DATABASE:[0,0,1],DATADIRPATH:[0,0,1],"grid-images":[0,1,1],DEBUG:[0,0,1],"table-data-and-image":[0,1,1],"table-data":[0,1,1],"list-pages":[0,1,1],"find-images":[0,1,1]}},terms:{wild:0,hyper:0,newest:2,help:1,just:0,show:[0,1,3],cheat:0,text:0,untrust:0,sort_r:[0,2],rest:[],syntax:0,shape:0,"3x3":0,comma:0,file:[0,2],follow:[0,2],primer:0,vari:[0,2],find:[0,2],languag:0,paramet:[0,3],web:1,style:0,note:[0,2],number:0,system:3,varik:[],subdata:0,flask:0,fix:[0,3],configur:0,specif:0,param:[0,2],should:0,rel:0,init:[0,1],png:2,under:[0,2],defin:0,match:0,real:0,applic:0,them:0,string:0,variou:0,get:0,dest:1,faq:0,bear:0,becaus:0,nestedkey1:0,grid:[0,2],command:[0,1,3],network:0,insert:0,ninja:0,sysmtem:0,how:0,mypag:0,dim:0,search:[0,3],docuitil:0,graph_2:2,name:0,organ:[0,1],graph_1:2,edit:[0,3],docutil:0,tran:[0,2],list:[0,3],integ:0,separ:0,did:[0,3],bad:0,exampl:[0,2],mode:[0,1],contain:0,debug:[0,1],found:2,relpath:[0,2],where:[0,1],page:[0,2,3],view:0,unexpectedli:0,magic:0,set:[0,1],dictdiff:[0,2],seq:0,another_opt:0,creation:3,some:0,direct:[0,2],see:[0,2],result:[0,2],arg:[0,2],home:0,happen:0,changelog:[0,3],port:1,special:[0,2],out:0,variabl:0,index:0,what:0,scale:2,matrix:0,compar:2,space:0,databas:0,user:[0,3],whoosh:0,content:[0,2],delet:0,version:[0,3],exit:1,directori:[0,1],werkzeug:0,basic:[0,2],"new":0,leftmost:0,experi:[0,2],localhost:0,refer:0,full:0,run:[0,1,3],linear:0,parent:0,numer:1,gener:[0,2],another_paramet:0,usag:[0,1,2],differ:[0,3],like:[0,2],quick:0,base:[0,2],dictionari:0,address:0,releas:3,path:[0,2,3],argument:[0,1],interpret:0,box:3,about:0,revers:[0,3],workaround:3,column:0,root:[0,1],anyth:0,alon:1,simul:1,filter:0,etc:3,stand:1,cowboi:0,chang:0,mean:0,interact:0,gamma:[0,2],first:[0,3],restructuredtext:0,listen:1,overview:0,hyphen:0,period:0,systemat:0,two:0,order:[0,2],unix:0,right:3,subpag:0,messag:[0,1],markup:0,diff:2,guid:0,open:1,your:0,second:0,kei:0,given:0,sheet:0,val:0,start:[0,1],top:[2,3],support:0,tail:0,least:[0,3],avail:0,width:[0,2,3],json:[0,2],datadirpath:[0,2],valu:[0,3],regrad:0,type:0,key1:0,more:0,"function":0,flat:3,from:[0,3],shell:0,option:[0,1,2],form:0,python:[0,3],imag:[0,2,3],regard:0,convert:3,specifi:0,idea:0,warn:0,flag:0,link:[0,2,3],too:3,card:0,"true":[0,1],than:0,neorg:[0,1,3],serv:[0,1,3],texsts_with_a:0,onli:0,word:0,target:0,"_temp_":[0,2],"default":[0,1],remov:0,access:[0,2,3],tree:2,displai:0,charact:0,project:0,transpos:0,invok:0,paragraph:2,texsts_with_a_:0,can:[0,2,3],assum:2,glossari:0,slash:0,problem:3,purpos:[0,2],similar:2,fetch:0,browser:[0,1],sort:0,sqlite:0,weaker:0,traceback:3,abov:[0,2],highlight:3,ran:0,key2:0,nestedkey2:0,ani:0,templat:[0,2],repres:0,titl:3,replac:[0,2],exist:[0,1,3],have:[0,2],tabl:[0,2,3],need:0,"import":0,exclud:[0,2],seed:2,repeatedli:0,alwai:0,end:0,newlin:0,want:[0,2],shown:0,alphabet:0,make:[0,2],format:0,when:[0,2,3],detail:0,check:3,power:0,also:[0,2],other:0,role:0,posit:1,which:0,test:0,page_path:0,you:[0,2],document:0,singl:0,higher:0,under_scor:0,relat:0,http:0,webserv:1,clash:[0,3],still:3,nest:[0,3],after:0,someon:0,express:0,befor:3,beta:[0,2],regular:0,queri:0,initi:1,mai:[0,2],alpha:[0,2],underscor:0,data:[0,2,3],everyth:0,demonstr:0,sub:[0,1,3],produc:2,bar:0,"short":3,don:[0,2],equival:0,bug:3,url:0,thu:0,descript:0,correspond:0,doe:[0,3],inform:0,write:0,environ:0,block:0,thi:[0,1,2],pattern:0,escap:0,effect:0,dimension:0,sibl:0,includ:0},objtypes:{"0":"std:envvar","1":"rst:directive"},titles:["NEOrg Reference Guide","NEOrg commands","Example usages of the special directives","ChangeLog"],objnames:{"0":"environment variable","1":"reStructuredText directive"},filenames:["index","commands","examples","changelog"]})