close fullscreen

A Rule is any configuration applied to a Set of cards.

 

Example

help edit space_dashboard

Permission to update a given card is based on its *update rule.   A new Wagn comes with several update rules, including these two:

  • All cards can be updated by Anyone Signed In.
  • Layout cards can be updated only by Administrators.

By "Layout cards", we mean cards that have the type "Layout".   Since the set of "Layout cards" is narrower than the set of "all cards", the second rule overrides the first, and only Administrators are permitted to edit Layout cards.

 

How To

help edit space_dashboard

NOTE: This documentation is focused on card rules, meaning rules that are set in card content.  Software developers can also add code rules via mods.

 

navigating to rules

 

The first part of working with rules is knowing how to access them .  You can navigate to a rule from...

  1. Any card to which the rule applies. For example, from the menu of the roadmap card, if you go to advanced > rules, you'll see all the rules that apply to roadmap.
  2. The rule's Set. Every Set is represented by a card, like *all, *star, Recipe+*type, or roadmap+*self.  The set card shows all the rules that apply to that Set.
  3. The rule's Setting.  Similarly, every setting has its own card, like *create, *structure, or *layout.  The setting card shows all the diffferent rules for that setting.
  4. Related "set anchor" cards.  From the card menu on "Recipe", you can navigate to advanced > rules > All "Recipe" cards or advanced > rules > All "+Recipe" cards in order to work with all the rules for those sets. 
  5. The navbox. Of course, every rule has its own card, so if you know its name, you can navigate directly to the rule by name in the navbox or straight from your browser bar.

 

editing rules

 

If you navigate to rules via the menu (#1 above), you will see a set of rules that looks something like the following:

view (options) not supported for roadmap

You can click on any setting (create, read, update, etc) to open that setting.   If you have update permission on the rule (which most wagn.org users don't), you will go straight to an edit view that will prompt you to edit the content of the rule and to choose the set to which it applies.

 

 

naming rules

 

The basic formula for the name of a rule card is Set+Setting.

 

For example, the default permission for who can read cards is set with this permission rule:

help edit space_dashboard
Anyone
more_horiz
open_in_full page
fullscreen modal
edit edit
space_dashboard advanced

This follows the Set+Setting=Rule pattern as follows:

  1. *all is the Set of all cards.  (The types of *all is "Set")
  2. *read is the Setting that determines who can read cards in the set  (The types of *read is "Setting")
  3. *all+*read is the Rule that determines who can read any card on a Wagn.
Because it applies to the *all set, this is a very broad rule that can be overridden by narrower rules. For example, new Wagns come with this rule:
This rule restricts permission to view the "Administrator+links" card so that only users with the Administrator role can see it.  Even though the card is in the *all set as well, this narrower rule overrides the broader rule above.
 
Note that in the above example, the set ( Administrator+links+*self) is itself a compound names.  Learn more about Set naming conventions on the Set card.

 

Tips

help edit space_dashboard
  •  You can click directly on advanced as a shortcut for advanced > rules. (Menu items with submenus typically go directly to the first item in the submenu.)

 

Discussion

help edit space_dashboard

The "Example" section should be less concerned with explaining how rules are named and more concerned with helping users understand how to interact with them.  Most beginning Wagneers should not have to learn about how rules are named.  (but that should be explained at the bottom of the How To section)

 
Tickets relevant to rules