Help Files

Guide to Using Datanet Commands

ABOUT THE GUIDE
This guide is structured as a step-by-step tutorial to help you master the
usage
of Datanet commands. It covers both basic and advanced techniques, providing 
detailed explanations for each command and its parameters. The guide includes 
specific information on how restrictions work in regards to conditions such as 
equals division and greater than or equal to rank.

EMPOWERMENTS

A common mistake people make is that * means all, because * is a common wild
card indicator. But think about where if anywhere the mud allows players to use
a wild card indicator for any command or prompt. In this case, clandb_* just
encompasses all possible clandb_[whatever] empowerments. While not covered in
this guide, it is possible to restrict view or edit rights to pages based on
empowerments, and this is where clandb_* really comes in because you could
restrict a global top secret page to everyone with clandb_topsecret instead
of their rank and division. The only hardcoded clandb_[empowerment] that 
matter mechanically outside this are clandb_edit which allows on to edit pages
and clandb_root which allows someone other than the clan leader to ignore 
restrictions. Clandb_view is also an empowerment, but everyone in the clan 
has this technically already.

COMMANDS

Viewing Pages
To view a page in the clan database:
datanet view <path>

Searching
To search for pages within the clan database:
datanet search <keywords>

Editing Pages
To edit an existing page in the clan database:
datanet edit <path>

Creating Pages
To create a new page in the clan database:
datanet edit --title "<title>" <path>

Deleting Pages
To delete a page from the clan database:
datanet delete <path>

Access Restrictions
Restrictions allow you to control access to specific paths within the clan 
database. You can customize access based on conditions such as equality, 
division, and rank. Here are some examples:

View Restrictions
To restrict view access to a specific path:
datanet --root restrict view add <path> allow <condition>

Edit Restrictions
To restrict edit access to a specific path:
datanet --root restrict edit add <path> allow <condition>

Conditions
name eq <position>: Matches the specific position within the clan (leader, 
first, second).
division eq <division number>: Matches a specific division within the clan.
rank <operator> <rank number>: Matches a specific rank within the clan 
hierarchy. Operators include eq (equals), gt (greater than), lt (less than),
gte
(greater than or equal to), lte (less than or equal to).

Modifying Default Chain Behavior
By default, chains deny access unless otherwise allowed. You can modify the 
default behavior using the default subcommand:
datanet --root restrict <command> default <path> <action>

Viewing Restrictions
To view existing restrictions:
datanet --root restrict <command> view all

Examples

Setup a private space for the clan leaders where other members can't view, 
search, or edit:
datanet --root restrict view /private/leadership/ add allow name eq leader
datanet --root restrict view /private/leadership/ add allow name eq first
datanet --root restrict view /private/leadership/ add allow name eq second
datanet --root restrict edit /private/leadership/ add allow name eq leader
datanet --root restrict edit /private/leadership/ add allow name eq first
datanet --root restrict edit /private/leadership/ add allow name eq second