Update versionv0.3

3 files changed, 349 insertions, 252 deletions

diff --git a/doc/build/man/papis-config.1 b/doc/build/man/papis-config.1
index cfdab779..3902ac7d 100644
--- a/doc/build/man/papis-config.1
+++ b/doc/build/man/papis-config.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "PAPIS-CONFIG" "1" "Sep 21, 2017" "0.2" "papis"
+.TH "PAPIS-CONFIG" "1" "Oct 03, 2017" "0.3" "papis"
 .SH NAME
 papis-config \- Papis Configuration
 .
@@ -136,6 +136,17 @@ Default: \fBFalse\fP
 .B add\-interactive
 Default: \fBFalse\fP
 .TP
+.B add\-name
+Default: 
+.nf
+\(ga\(ga
+.fi
+
+.nf
+\(ga\(ga
+.fi
+
+.TP
 .B add\-open
 Default: \fBFalse\fP
 .TP
@@ -219,127 +230,6 @@ Default: \fBMozilla/5.0 (Macintosh; Intel Mac OS X 10_9_3) AppleWebKit/537.36 (K
 .B xeditor
 Default: \fBxdg\-open\fP
 .UNINDENT
-.SS rofi\-gui
-.INDENT 0.0
-.TP
-.B case_sensitive
-Default: \fBFalse\fP
-.TP
-.B eh
-Default: \fB3\fP
-.TP
-.B fixed_lines
-Default: \fB20\fP
-.TP
-.B fullscreen
-Default: \fBFalse\fP
-.TP
-.B header\-format
-.INDENT 7.0
-.TP
-.B Default:
-.INDENT 7.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-<b>{doc[title]}</b>
-{doc[empty]}  <i>{doc[author]}</i>
-{doc[empty]}  <span foreground="red">({doc[year]:\->4})</span><span foreground="green">{doc[tags]}</span>
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.UNINDENT
-.TP
-.B key\-browse
-Default: \fBAlt+u\fP
-.TP
-.B key\-delete
-Default: \fBAlt+d\fP
-.TP
-.B key\-edit
-Default: \fBAlt+e\fP
-.TP
-.B key\-help
-Default: \fBAlt+h\fP
-.TP
-.B key\-normal\-window
-Default: \fBAlt+w\fP
-.TP
-.B key\-open
-Default: \fBEnter\fP
-.TP
-.B key\-open\-stay
-Default: \fBAlt+o\fP
-.TP
-.B key\-quit
-Default: \fBAlt+q\fP
-.TP
-.B lines
-Default: \fB10\fP
-.TP
-.B markup_rows
-Default: \fBTrue\fP
-.TP
-.B multi_select
-Default: \fBTrue\fP
-.TP
-.B normal_window
-Default: \fBFalse\fP
-.TP
-.B sep
-Default: \fB|\fP
-.TP
-.B width
-Default: \fB80\fP
-.UNINDENT
-.SS vim\-gui
-.INDENT 0.0
-.TP
-.B delete\-key
-Default: \fBdd\fP
-.TP
-.B edit\-key
-Default: \fBe\fP
-.TP
-.B header\-format
-.INDENT 7.0
-.TP
-.B Default:
-.INDENT 7.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-Title : {doc[title]}
-Author: {doc[author]}
-Year  : {doc[year]}
-\-\-\-\-\-\-\-
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.UNINDENT
-.TP
-.B help\-key
-Default: \fBh\fP
-.TP
-.B next\-search\-key
-Default: \fBn\fP
-.TP
-.B open\-dir\-key
-Default: \fB<S\-o>\fP
-.TP
-.B open\-key
-Default: \fBo\fP
-.TP
-.B prev\-search\-key
-Default: \fBN\fP
-.TP
-.B search\-key
-Default: \fB/\fP
-.UNINDENT
 .SS tk\-gui
 .INDENT 0.0
 .TP
@@ -472,6 +362,127 @@ Default: \fB700\fP
 .B window\-width
 Default: \fB1200\fP
 .UNINDENT
+.SS rofi\-gui
+.INDENT 0.0
+.TP
+.B case_sensitive
+Default: \fBFalse\fP
+.TP
+.B eh
+Default: \fB3\fP
+.TP
+.B fixed_lines
+Default: \fB20\fP
+.TP
+.B fullscreen
+Default: \fBFalse\fP
+.TP
+.B header\-format
+.INDENT 7.0
+.TP
+.B Default:
+.INDENT 7.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+<b>{doc[title]}</b>
+{doc[empty]}  <i>{doc[author]}</i>
+{doc[empty]}  <span foreground="red">({doc[year]:\->4})</span><span foreground="green">{doc[tags]}</span>
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.TP
+.B key\-browse
+Default: \fBAlt+u\fP
+.TP
+.B key\-delete
+Default: \fBAlt+d\fP
+.TP
+.B key\-edit
+Default: \fBAlt+e\fP
+.TP
+.B key\-help
+Default: \fBAlt+h\fP
+.TP
+.B key\-normal\-window
+Default: \fBAlt+w\fP
+.TP
+.B key\-open
+Default: \fBEnter\fP
+.TP
+.B key\-open\-stay
+Default: \fBAlt+o\fP
+.TP
+.B key\-quit
+Default: \fBAlt+q\fP
+.TP
+.B lines
+Default: \fB10\fP
+.TP
+.B markup_rows
+Default: \fBTrue\fP
+.TP
+.B multi_select
+Default: \fBTrue\fP
+.TP
+.B normal_window
+Default: \fBFalse\fP
+.TP
+.B sep
+Default: \fB|\fP
+.TP
+.B width
+Default: \fB80\fP
+.UNINDENT
+.SS vim\-gui
+.INDENT 0.0
+.TP
+.B delete\-key
+Default: \fBdd\fP
+.TP
+.B edit\-key
+Default: \fBe\fP
+.TP
+.B header\-format
+.INDENT 7.0
+.TP
+.B Default:
+.INDENT 7.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+Title : {doc[title]}
+Author: {doc[author]}
+Year  : {doc[year]}
+\-\-\-\-\-\-\-
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.TP
+.B help\-key
+Default: \fBh\fP
+.TP
+.B next\-search\-key
+Default: \fBn\fP
+.TP
+.B open\-dir\-key
+Default: \fB<S\-o>\fP
+.TP
+.B open\-key
+Default: \fBo\fP
+.TP
+.B prev\-search\-key
+Default: \fBN\fP
+.TP
+.B search\-key
+Default: \fB/\fP
+.UNINDENT
 .SH AUTHOR
 Alejandro Gallo
 .SH COPYRIGHT
diff --git a/doc/build/man/papis.1 b/doc/build/man/papis.1
index e25d2c07..b46a7632 100644
--- a/doc/build/man/papis.1
+++ b/doc/build/man/papis.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "PAPIS" "1" "Sep 21, 2017" "0.2" "papis"
+.TH "PAPIS" "1" "Oct 03, 2017" "0.3" "papis"
 .SH NAME
 papis \- Papis Documentation
 .
@@ -482,6 +482,17 @@ Default: \fBFalse\fP
 .B add\-interactive
 Default: \fBFalse\fP
 .TP
+.B add\-name
+Default: 
+.nf
+\(ga\(ga
+.fi
+
+.nf
+\(ga\(ga
+.fi
+
+.TP
 .B add\-open
 Default: \fBFalse\fP
 .TP
@@ -565,127 +576,6 @@ Default: \fBMozilla/5.0 (Macintosh; Intel Mac OS X 10_9_3) AppleWebKit/537.36 (K
 .B xeditor
 Default: \fBxdg\-open\fP
 .UNINDENT
-.SS rofi\-gui
-.INDENT 0.0
-.TP
-.B case_sensitive
-Default: \fBFalse\fP
-.TP
-.B eh
-Default: \fB3\fP
-.TP
-.B fixed_lines
-Default: \fB20\fP
-.TP
-.B fullscreen
-Default: \fBFalse\fP
-.TP
-.B header\-format
-.INDENT 7.0
-.TP
-.B Default:
-.INDENT 7.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-<b>{doc[title]}</b>
-{doc[empty]}  <i>{doc[author]}</i>
-{doc[empty]}  <span foreground="red">({doc[year]:\->4})</span><span foreground="green">{doc[tags]}</span>
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.UNINDENT
-.TP
-.B key\-browse
-Default: \fBAlt+u\fP
-.TP
-.B key\-delete
-Default: \fBAlt+d\fP
-.TP
-.B key\-edit
-Default: \fBAlt+e\fP
-.TP
-.B key\-help
-Default: \fBAlt+h\fP
-.TP
-.B key\-normal\-window
-Default: \fBAlt+w\fP
-.TP
-.B key\-open
-Default: \fBEnter\fP
-.TP
-.B key\-open\-stay
-Default: \fBAlt+o\fP
-.TP
-.B key\-quit
-Default: \fBAlt+q\fP
-.TP
-.B lines
-Default: \fB10\fP
-.TP
-.B markup_rows
-Default: \fBTrue\fP
-.TP
-.B multi_select
-Default: \fBTrue\fP
-.TP
-.B normal_window
-Default: \fBFalse\fP
-.TP
-.B sep
-Default: \fB|\fP
-.TP
-.B width
-Default: \fB80\fP
-.UNINDENT
-.SS vim\-gui
-.INDENT 0.0
-.TP
-.B delete\-key
-Default: \fBdd\fP
-.TP
-.B edit\-key
-Default: \fBe\fP
-.TP
-.B header\-format
-.INDENT 7.0
-.TP
-.B Default:
-.INDENT 7.0
-.INDENT 3.5
-.sp
-.nf
-.ft C
-Title : {doc[title]}
-Author: {doc[author]}
-Year  : {doc[year]}
-\-\-\-\-\-\-\-
-.ft P
-.fi
-.UNINDENT
-.UNINDENT
-.UNINDENT
-.TP
-.B help\-key
-Default: \fBh\fP
-.TP
-.B next\-search\-key
-Default: \fBn\fP
-.TP
-.B open\-dir\-key
-Default: \fB<S\-o>\fP
-.TP
-.B open\-key
-Default: \fBo\fP
-.TP
-.B prev\-search\-key
-Default: \fBN\fP
-.TP
-.B search\-key
-Default: \fB/\fP
-.UNINDENT
 .SS tk\-gui
 .INDENT 0.0
 .TP
@@ -818,10 +708,152 @@ Default: \fB700\fP
 .B window\-width
 Default: \fB1200\fP
 .UNINDENT
+.SS rofi\-gui
+.INDENT 0.0
+.TP
+.B case_sensitive
+Default: \fBFalse\fP
+.TP
+.B eh
+Default: \fB3\fP
+.TP
+.B fixed_lines
+Default: \fB20\fP
+.TP
+.B fullscreen
+Default: \fBFalse\fP
+.TP
+.B header\-format
+.INDENT 7.0
+.TP
+.B Default:
+.INDENT 7.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+<b>{doc[title]}</b>
+{doc[empty]}  <i>{doc[author]}</i>
+{doc[empty]}  <span foreground="red">({doc[year]:\->4})</span><span foreground="green">{doc[tags]}</span>
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.TP
+.B key\-browse
+Default: \fBAlt+u\fP
+.TP
+.B key\-delete
+Default: \fBAlt+d\fP
+.TP
+.B key\-edit
+Default: \fBAlt+e\fP
+.TP
+.B key\-help
+Default: \fBAlt+h\fP
+.TP
+.B key\-normal\-window
+Default: \fBAlt+w\fP
+.TP
+.B key\-open
+Default: \fBEnter\fP
+.TP
+.B key\-open\-stay
+Default: \fBAlt+o\fP
+.TP
+.B key\-quit
+Default: \fBAlt+q\fP
+.TP
+.B lines
+Default: \fB10\fP
+.TP
+.B markup_rows
+Default: \fBTrue\fP
+.TP
+.B multi_select
+Default: \fBTrue\fP
+.TP
+.B normal_window
+Default: \fBFalse\fP
+.TP
+.B sep
+Default: \fB|\fP
+.TP
+.B width
+Default: \fB80\fP
+.UNINDENT
+.SS vim\-gui
+.INDENT 0.0
+.TP
+.B delete\-key
+Default: \fBdd\fP
+.TP
+.B edit\-key
+Default: \fBe\fP
+.TP
+.B header\-format
+.INDENT 7.0
+.TP
+.B Default:
+.INDENT 7.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+Title : {doc[title]}
+Author: {doc[author]}
+Year  : {doc[year]}
+\-\-\-\-\-\-\-
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.TP
+.B help\-key
+Default: \fBh\fP
+.TP
+.B next\-search\-key
+Default: \fBn\fP
+.TP
+.B open\-dir\-key
+Default: \fB<S\-o>\fP
+.TP
+.B open\-key
+Default: \fBo\fP
+.TP
+.B prev\-search\-key
+Default: \fBN\fP
+.TP
+.B search\-key
+Default: \fB/\fP
+.UNINDENT
 .SH THE INFO.YAML FILE
 .sp
-At the heart of papis there is the information file.
-The info file contains all information about the documents.
+At the heart of papis there is the information file.  The info file contains
+all information about the documents.
+.sp
+It uses the \fI\%yaml\fP syntax to store
+information, which is a very human readable language. It is quite format free,
+\fIpapis\fP does not assume that any special information should be there.
+.sp
+If you are storing papers with papis, then you most probably would like to
+store author and title in there,
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+author: Isaac Newton
+title: Opticks, or a treatise of the reflections refractions, inflections and
+  colours of light
+files:
+  \- document.pdf
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
 .SH THE DATABASE
 .sp
 One of the things that makes papis interesting is the fact
@@ -943,10 +975,10 @@ use\-cache = True
 .ft C
 usage: papis add [\-h] [\-d DIR] [\-i] [\-\-name NAME] [\-\-title TITLE]
                  [\-\-author AUTHOR] [\-\-from\-bibtex FROM_BIBTEX]
-                 [\-\-from\-yaml FROM_YAML] [\-\-from\-url FROM_URL]
-                 [\-\-from\-doi FROM_DOI] [\-\-from\-pmid FROM_PMID]
-                 [\-\-from\-vcf FROM_VCF] [\-\-to [TO]] [\-\-confirm] [\-\-open]
-                 [\-\-edit] [\-\-commit] [\-\-no\-document]
+                 [\-\-from\-yaml FROM_YAML] [\-\-from\-folder FROM_FOLDER]
+                 [\-\-from\-url FROM_URL] [\-\-from\-doi FROM_DOI]
+                 [\-\-from\-pmid FROM_PMID] [\-\-from\-vcf FROM_VCF] [\-\-to [TO]]
+                 [\-\-confirm] [\-\-open] [\-\-edit] [\-\-commit] [\-\-no\-document]
                  [document [document ...]]
 .ft P
 .fi
@@ -974,7 +1006,7 @@ Do some of the actions interactively
 Default: False
 .TP
 .B\-\-name
-Name for the main folder
+Name for the document’s folder (papis format)
 .sp
 Default: “”
 .TP
@@ -998,6 +1030,11 @@ Parse information from a yaml file
 .sp
 Default: “”
 .TP
+.B\-\-from\-folder
+Add document from folder being a valid papis document (containing info.yaml)
+.sp
+Default: “”
+.TP
 .B\-\-from\-url
 Get document and information from agiven url, a parser must be implemented
 .sp
@@ -1413,6 +1450,55 @@ Commands
 .sp
 Default: “”
 .UNINDENT
+.SH QUERY LANGUAGE
+.sp
+Since version \fI0.3\fP there is a query language in place for the searching
+of documents. To illustrate it here are some examples:
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.IP \(bu 2
+Open documents where the author key matches ‘albert’ (ignoring case),
+year matches ‘19’ (i.e., 1990, 2019, 1920):
+.INDENT 2.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+papis open \(aqauthor = albert year = 05\(aq
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.IP \(bu 2
+Add the restriction to the previous search that the usual matching matches
+the substring ‘licht’ in addition to the previously selected
+.INDENT 2.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+papis open \(aqauthor = albert year = 05 licht\(aq
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+This is not to be mixed with the restriction that the key \fIyear\fP matches
+\fI‘05 licht’\fP, which will not match any year, i.e.
+.INDENT 2.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+papis open \(aqauthor = albert year = "05 licht"\(aq
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.UNINDENT
 .SH CUSTOM SCRIPTS
 .sp
 As in \fI\%git\fP, you can write custom scripts to
diff --git a/papis/__init__.py b/papis/__init__.py
index c13efd98..a3bedcba 100644
--- a/papis/__init__.py
+++ b/papis/__init__.py
@@ -1,7 +1,7 @@
 
 # Information
 __license__ = 'GPL3'
-__version__ = '0.2'
+__version__ = '0.3'
 __author__ = __maintainer__ = 'Alejandro Gallo'
 __email__ = 'aamsgallo@gmail.com'