Skip to content

Commit

Permalink
add block editor documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jeriox committed Sep 19, 2024
1 parent 4fec334 commit 2b7867b
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 2 deletions.
36 changes: 36 additions & 0 deletions docs/user/events/blocks.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
Preconfigured shift structures
==============================

When configuring a shift, you can choose to use a preconfigured shift structure (see :doc:`user/events/signup`).
The blocks can be configured in the editor, which can be reached from the shift edit view.

Adding blocks
-------------
To add a block, click on the "Add atomic block" or "Add composite block" button. If there are blocks already, you can also
click on the copy icon of block in the block list on the right side of the editor to add a copy of the block.
A form for the new block will appear on the left side in the editor. There are two types of blocks:


Atomic blocks
^^^^^^^^^^^^

An atomic block is the smallest unit of a block structure. It has a block name and a list of positions.
Each position can also be named and has a list of required qualifications. The position can also be marked as optional.
One position represents one person in the structure. Below the positions, you can allow more participants than positions.
This can be compared to not setting a maximum number of participants for a shift with another shift structure.
You can also define additional conditions for the block, e.g. that everyone has a drivers license.

Composite blocks
^^^^^^^^^^^^^^^

Composite blocks are a combination of multiple other blocks, both atomic and composite. After adding a composite block,
it can be given a name. Then, you can add other blocks to the composite block. This is done by clicking the arrow on one
of the blocks in the block list on the right side of the editor. The included block can also be labeled, e.g. to assign
a unique name to a block that is included multiple times in the composite block.
The composite block can also have additional conditions in the same way as atomic blocks.

Editing and deleting blocks
---------------------------
By clicking on a block in the block list on the right side of the editor, you can edit the block. This will show the form
for the block on the left side of the editor. To delete a block, click on the trash icon of the block in the block list.
Keep in mind that changes will be applied to all shifts using this block.
1 change: 1 addition & 0 deletions docs/user/events/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ event types, signup configuration and so on.

events
signup
blocks
4 changes: 2 additions & 2 deletions docs/user/events/signup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The shift structure configures **who** can sign up for the shift and how personn
To cover different use cases, ephios offers different signup flows and shift structures.
Plugins might provide additional flows and structures that can be freely mixed with the default ones.

Available signup flows
Signup flows
-----------------------

Signup flows check how people can sign up for your shift.
Expand Down Expand Up @@ -86,7 +86,7 @@ Preconfigured Structure
^^^^^^^^^^^^^^^^^^^^^^^

This is a very flexible way to structure a shift where various qualifications are required.
Configure reusable nested templates with labels and qualification requirements using the web editor.
Configure reusable nested blocks with labels and qualification requirements using the web editor (see :doc:`user/events/blocks`).

In your shift, configure a block to use for that shift.
Participants can be asked for their preferred unit, their choice will then be displayed in the disposition.
Expand Down

0 comments on commit 2b7867b

Please sign in to comment.