h1. Sutekh Tutorial

h2. Contents

# "The Initial Layout":#intro
# "Working with cards":#cards
# "Manipulating Panes":#panes
# "Managing Card Sets":#sets
# "Filtering":#filtering
# "Useful Tips":#tips

h2(#intro). The Initial Layout

When you run Sutekh for the first time, it will display the following 4 panes.

* White Wolf Card List
* Card Text
* Card Set List
* My Collection

On subsequent runs, the list of panes to show will be read from file. You
can determine which panes are shown either by explicitly saving the layout
using *Save current pane set* from the *File->Preferences*, or by letting the 
*Save Pane Set on Exit* option save the configuration.

h3. The White wolf card list

Sutekh maintains a list of all the cards published by White Wolf as the
_White Wolf Card List_. This lists all the cards, and, for each card, the
expansions it has appeared in. 

h3. Card Text

The pane displays the information about the currently selected card.

h3. Card Sets

Sutekh deals with collections of cards as card sets. Card Sets can either be
stand-alone, or subsets of other card sets. This pane lists all the card sets
which have been created. Initially, only a card set called _My Collection_
is created, to hold the details of your card collection.

h3. My Collection

This card set will hold the details of your card collection.

h2(#cards). Working with Cards

h3. Adding cards to a card set

Card Sets are, by default, not editable, unless they are empty. This can be
changed by toggling the *Card Set is Editable* menu entry in the *Edit* Menu
of the pane. Empty card sets are always editable. Before adding cards to a card
set, ensure it is editable.

Cards can be added by dragging them from the _White Wolf Card List_ to the pane
for the card set. Selecting multiple cards will add a single copy of each
selected cards. You can also use the copy & paste options from the edit menu.

When a card set is editable, *+* and *-* buttons will be shown next to the card
names. These can be used to increase or decrease the number for a given card.

The number can also be changed using the keyboard: '+' and '-' will
increment and decrement counts, while the numbers 1 to 9 can be used to set
the count for the given card to that value.

You can also copy or drag-n-drop cards from other card sets. Unlike copying 
from the _White Wolf Card List_, copying from another card sets will copy all 
the selected cards.

h3. Removing cards

Cards can be removed from a card set either by using the *-* button shown in
the card set pane next to the card name, using the keyboard shortcuts to change
the number of cards, or by selecting cards and using the *Delete selection*
option from the *Edit* menu.

h2(#panes). Manipulating Panes

The Sutekh user interface consists of panes. The number of panes and the layout
is entirely up to you. 

Panes can be added using the *Add Pane* Menu, while the contents of the
currently selected pane can be replaced using the *Replace Pane* Menu. New
blank panes can also be added by splitting the current pane, either into
two panes next to each other, or into two panes stacked one above the other.
Panes can be swapped by dragging a pane to it's new location. 

Card sets will be opened in a new pane added on the right by double clicking
on the entry in the _Card Set_ list. Card sets can also be opened in a specific
pane by dragging the card set name from the _Card Set_ list to the desired
pane.

If the *Save Pane Set on Exit* option in the *File->Preferences* menu is
set, Sutekh will save the current layout when you exit, and restore it on
startup. You can also save the current layout using the *Save Current Pane Set*
option.

Panes are removed from the list by closing them from the
*Pane Actions->Remove current pane* menu option (or the associated keyboard
shortcut). Card Set panes will also be closed if you delete the card set.

h2(#sets). Managing Card Sets

h3. Creating a new card set

A new card set can be created from the _Card Set List_, using *Create New
Card Set* option from the *Actions* menu. The name is required, and must be
unique. A Card set can either have _No Parent_, in which case it is a stand
alone card set, or you can choose any existing card set as the parent, in
which case it is a subset of that card set. 

h3. Renaming a card set.

A card set can be renamed using the *Edit Card Set Properties* option
from the card set list's *Actions* Menu. An open card set can also be renamed
via the *Edit Card Set Properties* from the *Actions* Menu of the card set.

h3. Changing the parent of a card set.

The parent of a card set can by changed via the *Edit Card Set Properties*
option from the *Actions* Menu, or by dragging the selected card set onto it's
new parent in the card set list pane.

h3. Deleting a card set

Card sets can by deleted via the *Delete card set* from the *Actions* menu of
the card set list pane. Open card sets can also be deleted via the *Delete card
set* option from the *Actions* menu of the card set pane.

h3. _"In Use"_ Card sets

Card sets can be marked or unmarked as _"in use"_. The set of in use card sets
are considered to be those currently active. The display modes dealing with
child card sets only consider child cards sets that are marked as _"in use"_.

h3. The Different card display and count modes

Sutekh has several options which control which cards are displayed for a 
card set, and what information about the cards is displayed. 

The cards to display are also affected by the "filters":#filtering that are
applied.

h4. The _"Cards to Show"_ options

This option, controls which cards are displayed.

The default mode shows only those card that belong to the actual card set.

"Show All Cards" shows the entire list of cards. This mode is often useful
when entering cards into a card set for the first time

"Show all cards in parent card set" shows the combination of the card in this
card set and all the cards in the parent card set. It is useful for seeing
which cards are available for adding to a deck.

"Show all cards in child card sets" shows all cards that belong to the
_"in use"_ children of this card set in addition to the cards in this card
set.

h4. The _"Display Mode"_ options

This controls what information is displayed below the card name.

"Show Expansions", the default, shows which cards have been marked as belonging
to which expansions below the card name.

"Show No Children" disables anything below the card name.

"Show Child Card Sets" shows the allocation of cards to the _"in use"_ children
of the current card set.

"Show Expansions + Child Card Sets" shows the expansions as for
"Show Expansions", and shows the card set information for each expansion below
as well.

"Show Child Card Sets and Expansions" is the reverse of
"Show Expansions + Child Card Sets", showing the child card sets and the
expansion information below.

h4. The _"Parent Card Count"_ options

If the card set is the child of another card set, you can also display
information about the parent card set.

"Show Parent Count", the default, will just show the count of the same
card in the parent card set.

"Don't show parent card counts" disables the column with the parent count.

"Show difference between Parent Count and this card set" shows the difference
between the parent count and the count for this card set.

"Show difference between Parent Count and card sets in use" shows the
difference between the parent card set and total in all the _"in use"_ card
set. If this card set is *not* _"in use"_, then the number of cards in this
set does not influence this number.

h2(#filtering). Filtering

Sutekh has a very powerful filtering model, which allows quite complex queries
on the card database. 

h3. The Basic filters

There are a number of basic filters available for querying the card lists,
such as _Clan_, _Discipline_, _"Card Text"_ and so forth.

Most of these filters only allow a limited range of options which are
selected from a drop down list. The _Clan_ filter,
for example, only accepts the clans listed in the database as input. Multiple
items can be selected in this list, which means the filter matches on any of
those selections.

Other filters, such as the _"Card Text"_ filter, require you to enter a string.
The filter will match any card that contains this string. The '%' character
can be used as a wild card in this string to match any number of letters.

The _"Card Sets In Use"_ filter takes no input.

The _"Card Count"_ filter takes two selections. The first selects the card
counts to match against, while the second is the card set to test against. 

h3. Combing basic filters

These basic filters can be combined to create more complex queries. 

Multiple filters can be combined in 4 different ways. 

* All of
* Any of
* Not All of
* None of

Each of these allows multiple filters to be added to them, and then combine
all the included filters according to the chosen rule.

_"All of"_ requires the all the included filters to be satisfied simultaneously.
It useful for finding cards which require a discipline and a given cost, for
example.

_"Any of"_ requires that at least one of the included filters is satisfied. 

_"Not All of"_ requires that at least one of the included filters is not
satisfied. The difference between _"Not All of_" and _"Any of"_ is that _"Any
of"_ will include the results of any cards that match all of the filters, while
_"Not All of"_ will exclude those, but return cards that satisfy none of the
filters.

_"None of"_ requires that none of the included filters be satisfied.

In addition to the basic filters, the *Sub-filter* option allows these
combinations to be nested. Thus an _"All of"_ filter can include _"Any of"_ or
_"None of"_ filters below it, which allows for extremely complex queries to
be constructed.

For example, to find all cards that require either 'Follower of Set' or
'Serpentis', but not both, the following filter could be constructed:

An _"Any of"_ filter, which includes two _"All of"_ sub-filters. Each
sub-filter includes the _Clan_ and _Discipline_ basic filters, and the one is
set to match 'Followers of Set' and NOT 'Serpentis' while the other is set to
match NOT 'Followers of Set' and 'Serpentis'

Once a filter has been constructed, it can be saved with a given name and
loaded again later. 

h3. Filtering the Card Set List

The card set list can also filtered. The basic filters available here are:

* The card set name
* The card set author
* The card set comment
* The name of the parent card set
* Text in the annotations of the card set
* Filter on all card sets marked in use

These filters can be combined as well, allowing queries such as 'All of
card sets in use where the card set name includes "Nosferatu"'.

When filtering card sets, the card sets that match, *and their parents* are
shown, since this relationship is always important.


h2(#tips). Useful Tips

h3. Entering card sets

The different show card modes are often useful for entering a card set quickly.
Start with with "Show all cards" or "Show cards in parent card set" and then
increment the cards that belong to the card set. Another useful approach is
to use the "Card Set from Filter" option to create the card set.


"The Sutekh Manual":Manual.html
