aboutsummaryrefslogtreecommitdiff
path: root/docs/moving_data_between_collections.rst
diff options
context:
space:
mode:
authorElena ``of Valhalla'' Grandi <valhalla@trueelena.org>2020-10-01 23:04:58 +0200
committerElena ``of Valhalla'' Grandi <valhalla@trueelena.org>2020-10-01 23:04:58 +0200
commit8453c268f55ef7cfbc2fe6a6bc5c8ca7a67c8880 (patch)
tree2d4e0a4da734ee86cc546a92c383578ff59c8a3e /docs/moving_data_between_collections.rst
parentd120ee47de7d3c02a8420e3a615c6269f88def9c (diff)
Moved misc docs to sphinx
Diffstat (limited to 'docs/moving_data_between_collections.rst')
-rw-r--r--docs/moving_data_between_collections.rst40
1 files changed, 0 insertions, 40 deletions
diff --git a/docs/moving_data_between_collections.rst b/docs/moving_data_between_collections.rst
deleted file mode 100644
index 170b391..0000000
--- a/docs/moving_data_between_collections.rst
+++ /dev/null
@@ -1,40 +0,0 @@
-Moving Data between Collections
-===============================
-
-Entries can be exported from a lesana collection to another using the
-``lesana export`` command and a jinja2 template.
-
-The template should generate a yaml file that is a valid lesana entry
-for the destination collection and it can use the fields of the starting
-collection as variables. The variable ``entry`` is also available and
-gives complete access to the entry of the original collection, so fields
-with names that aren't valid jinja templates can be accessed as
-``entry.data[<field-name>]``.
-
-E.g. to convert between a collection with fields ``name``,
-``short-desc``, ``desc`` to a collection with fields ``name``,
-``description`` one could use the following template::
-
- name: {{ name }}
- description: |
- {{ entry.data.[short-desc] }}
-
- {{ desc | indent(width=4, first=False) }}
-
-From the origin collection you can then run the command::
-
- lesana export <path/to/destination/collection> <path/to/template>
-
-to export all entries.
-
-You can also export just a subset of entries by adding a xapian query
-with the parameter ``--query``; you can test the search using::
-
- lesana search --all <some search terms>
-
-and then actually run the export with::
-
- lesana search --query '<some search terms>' <destination> <template>
-
-note that in this second command the spaces in the search query have to
-be protected from the shell.