Skip to content

Commit 2074a8c

Browse files
authored
docs (#313)
1 parent 436ed4d commit 2074a8c

File tree

8 files changed

+22
-2
lines changed

8 files changed

+22
-2
lines changed

docs/images/daf-gui-front.png

31.3 KB
Loading
6.01 KB
Loading
8.62 KB
Loading
5.36 KB
Loading

docs/source/guide/GUI/live_view.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ While the Schema tab allows user to pre-define a schema, the GUI also has a sect
1313

1414
Live view allows users to view and update objects that are currently loaded into the framework.
1515
It allows users to modify the original object parameters and then reinitialize the object to use those same
16-
parameters. This can be done by clicking on the *Update* button.
16+
parameters. This can be done by clicking on the *Update* button. Next to the *Update* button, there is a
17+
*Refresh* button which will reload the GUI with updated values.
1718

1819
If an object does not have a *Update* button, that means the object is not directly supported for live modifications.
1920
In the latter case, users must click the *Save* button, until edit for an object, which supports
@@ -23,7 +24,7 @@ to the list.
2324

2425
.. image:: ./images/gui-live-view-edit-account.png
2526
:align: center
26-
:width: 15cm
27+
:width: 10cm
2728

2829

2930
At the top of the *Live view* tab, there's also an *Execute* button with a dropdown menu. It allows you to define a new

docs/source/guide/GUI/quickstart.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ GUI structure
2323
The GUI consists of:
2424

2525
- START and STOP buttons starting and stopping DAF's core,
26+
- Optional modules tab - Where you can install optional functionallity
2627
- Schema definition tab - Where you can define accounts, guilds, messages & type of logging:
2728

2829
- Accounts - Section for defining your accounts (and guilds and messages).

docs/source/guide/GUI/schema.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,14 @@ The *Load all at start* checkbox causes (when checked) the GUI to load all the a
194194
button in the top left corner is pressed. If the checkbox is not checked, accounts can be loaded by
195195
selecting them in the list and then clicking on the *Load selection to live* button.
196196

197+
The *Preserve state on shutdown* checkbox sets the ``save_to_file`` parameter inside :func:`~daf.core.run` to True if checked
198+
or False if not checked. Basically this means that if the checkbox is checked, DAF will save the accounts list (and guilds, messages, ...)
199+
to a binary file on DAF shutdown and every 2 minutes to prevent data loss on force shutdown.
200+
When starting DAF again, the same list will be loaded from file into DAF.
201+
202+
State preservation is not really meant as a shilling feature where you can define the schema statically inside the GUI and save it to a JSON file,
203+
but it's meant to be used in case DAF will have accounts, guilds, messages dynamically added while it's running (added in *Live view*).
204+
197205
If *Import from live* is pressed, the GUI will copy the accounts loaded inside daf into our list.
198206

199207
Logger is automatically loaded at start and cannot be changed for a different logger without stopping the framework first.

docs/source/guide/core/quickstart.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,16 @@ Function :func:`~daf.core.run` accepts many parameters but there is only one tha
8282
8383
daf.run(accounts=accounts)
8484
85+
.. _objects_in_file_ref:
86+
.. note::
87+
88+
DAF also supports the accounts list to be **saved to file** or **restored from file** on startup.
89+
90+
This behaviour can be enabled by setting the ``save_to_file`` parameter to ``True``.
91+
Please note that when this is set to ``True``, the framework will first load the accounts from file
92+
and then also load accounts present in the ``accounts`` parameter, which will result in *Account already added*
93+
warnings if the same account has been backed up to file before.
94+
8595

8696
After you've successfully defined your accounts list and started the framework with :func:`~daf.core.run`, the framework will run on it's own and there is nothing you need to do
8797
from this point forward if basic periodic shilling with text messages is all you desire.

0 commit comments

Comments
 (0)