Set checkboxes documentation

This commit is contained in:
Gregoo 2025-01-24 14:56:07 +01:00
parent 466e2e39d9
commit 30ea2ae567
9 changed files with 59 additions and 0 deletions

View File

@ -14,6 +14,7 @@ This page helps you navigate the documentation of BrickTracker.
- [First steps](first-steps.md)
- [Managing your sets](set.md)
- [Managing your set checkboxes](checkbox.md)
## Specific procedures

58
docs/checkbox.md Normal file
View File

@ -0,0 +1,58 @@
# Manage your set chechboxes
> **Note**
> The following page is based on version `1.1.0` of BrickTracker.
They are useful to store "yes/no" info about a set and quickly set it. Once clicked the change is immediatly stored in the database. A visual indicator tells you the change was succesful.
![](images/checkbox-01.png)
## Default checkboxes
The original version of BrickTracker defined the following checkboxes
- Minifigures are collected
- Set is checked
- Set is collected and boxed
## Visibility
The checkboxes are **never visible** on the front page. The display here tries to be as minimalistic as possible.
Prior to version `1.1.0`, the checkboxes were visible both on the Grid view (**Sets**) and the details of a set.
![](images/checkbox-02.png)
![](images/checkbox-03.png)
From version `1.1.0`, it is possible to decide if a checkbox is visible from the Grid or not. It will always be visible in a set details.
### Change the visibility of a checkbox
To change the visibility of a checkbox, head to the **Admin page** and open the **Checkboxes** section.
![](images/checkbox-04.png)
Simply click on the **Displayed on the Set Grid** checkbox to select whether it is displayed or not. The change is immediately saved to the database.
![](images/checkbox-05.png)
In this example, we have decided to have no checkbox visible on the Grid view.
![](images/checkbox-06.png)
## Management
Starting version `1.1.0`, you can manage the checkboxes for the **Checkboxes** section of the **Admin page**.
![](images/checkbox-04.png)
From there you can do the following:
- Add a new checkbox: use the last line of the list and press the **Add** button
- Rename an existing checkbox: use the **Name** field to change the name and press the **Rename** button
- Change the Grid display of an existing checkbox: tick or untick the **Displayed on the Set Grid** checkbox
- Delete an existing checkbox: use the **Delete** button and confirm on the following screen
It is possible to delete all the checkboxes, they are an optional component of a set.
![](images/checkbox-07.png)

BIN
docs/images/checkbox-01.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.8 KiB

BIN
docs/images/checkbox-02.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 773 KiB

BIN
docs/images/checkbox-03.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 389 KiB

BIN
docs/images/checkbox-04.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

BIN
docs/images/checkbox-05.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

BIN
docs/images/checkbox-06.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 948 KiB

BIN
docs/images/checkbox-07.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB