Mercurial > libervia-backend
diff doc/jp/event.rst @ 3041:72583524cfd3
doc (jp): jp commands are now fully documented:
rel 232
author | Goffi <goffi@goffi.org> |
---|---|
date | Tue, 01 Oct 2019 22:49:06 +0200 |
parents | |
children | 81c8910db91f |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/jp/event.rst Tue Oct 01 22:49:06 2019 +0200 @@ -0,0 +1,69 @@ +======================== +event: events management +======================== + +Event commands allows you to create/modify or get data about an event, and to manage your +invitees. + +.. _jp-event_get: + +get +=== + +Get metadata about a specific event. + +example +------- + +Retrieve an event metadata:: + + $ jp event get -n org.salut-a-toi.event:0__BsyCsXpcrRh44CQhSVTUMi -i 'org.salut-a-toi.event:0' + +.. _jp-event_create: + +create +====== + +Create a new event. You can specify the date of the event with ``-d DATE, --date DATE``, +and an id with ``-i ID, --id ID`` (default id is used if omitted). + +Configuration options are specified using ``-f KEY VALUE, --field KEY VALUE`` where key +can be a custom data or one of: + +name + name of the event +description + details of the event +image + URL of the main picture of the event +background-image + URL of image to use as background +register + a boolean value, set to ``true`` if you want to register the event in your local list + +example +------- + +Create an event about to celebrate New Year:: + + $ jp event create -d 2019-12-31 -f name "New Year's Eve" -f description "Party to celebrate new year" -f register true -f image https://example.net/some_image.jpg + + +modify +====== + +This command in the same way as jp-event_create_ but modify an existing event. You need to +specify the node of the event to modify using ``-n NODE, --node NODE``. + +example +------- + +Add a background image to the New Year event created above:: + + $ jp event modify -n org.salut-a-toi.event:0__d8QQLJvbcpDXxK66UBXKfT -f background-image https://example.net/some_background_image.jpg + + +invitee +======= + +Subcommands to handle guests. Please check :ref:`jp-event_invitee`.