aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorElena ``of Valhalla'' Grandi <valhalla@trueelena.org>2017-01-29 22:51:26 +0100
committerElena ``of Valhalla'' Grandi <valhalla@trueelena.org>2017-01-29 22:51:26 +0100
commit381ce71902e176f8f0d76f8330e74c871cbd46b3 (patch)
tree1a1fd3a1b3da665e35867b540f8a9b2aa82f92fd
parentc709c2eb5ebb3a661d228423860f3bdd46dac375 (diff)
Document templates
-rw-r--r--docs/getting_started_command_line.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/getting_started_command_line.rst b/docs/getting_started_command_line.rst
index 2c79701..c5dc007 100644
--- a/docs/getting_started_command_line.rst
+++ b/docs/getting_started_command_line.rst
@@ -47,3 +47,15 @@ open them with ``lesana edit``.
If you're using git, don't forget to add and commit the entries you've
added (i.e. the files under ``items``).
+
+Search results are limited by default to 12 matches; to get all results
+for your query you can use the option ``--all``. This is especially
+useful when passing the results to a template::
+
+ lesana search --template templates/my_report.html --all \
+ some search terms \
+ > some_search_terms-report.html
+
+will generate an html file based on the jinja2 template
+``templates/my_report.html`` with all the entries found for those search
+terms.