diff options
Diffstat (limited to 'docs/source/user')
| -rw-r--r-- | docs/source/user/settings.rst | 19 |
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 ------------------------------------ |