summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorElena ``of Valhalla'' Grandi <valhalla@trueelena.org>2021-02-10 09:32:37 +0100
committerElena ``of Valhalla'' Grandi <valhalla@trueelena.org>2021-02-10 09:32:37 +0100
commit836b4106aeef9acd30a4fd4dbca00c5d90e9aef7 (patch)
treeeed85d2ef57efee4a6332755c8bdbfe72a7dc18e /docs
parent8579962d017c4ec46d731b852353d38e4fb031df (diff)
Add the option to autoincrement integer values
Diffstat (limited to 'docs')
-rw-r--r--docs/source/user/settings.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/source/user/settings.rst b/docs/source/user/settings.rst
index fead752..c781f11 100644
--- a/docs/source/user/settings.rst
+++ b/docs/source/user/settings.rst
@@ -67,6 +67,25 @@ Some field types may add other custom properties.
you can use the ``yaml`` generic type, or write your own derivative
with an additional type).
+``integer`` properties
+----------------------
+
+``auto``:
+ automatic manipulation of the field contents.
+
+ The value of ``increment`` will autoincrement the value at every
+ update.
+
+ The reference client will run this update before editing an entry,
+ allowing further changes from the user; a command line user can then
+ decide to abort this change through the usual git commands.
+
+ Other clients may decide to use a different workflow.
+
+``increment``:
+ the amount by which an ``auto: increment`` field is incremented
+ (negative values are of course allowed).
+
``date`` and ``datetime`` properties
------------------------------------