[Pcgen-trackers_Docs] [ pcgen-Documentation Feature Requests-2016671 ] Document PCC File PRECAMPAIGN tag

[SourceForge.net <no...@so...>]

Documentation Feature Requests item #2016671, was opened at 2008-07-12 11:47
Message generated for change (Comment added) made by maredudd800
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=748235&aid=2016671&group_id=25576

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: Documentation New Tag(s)
Group: For 5.16.0
Status: Closed
Resolution: Accepted
Priority: 6
Private: No
Submitted By: Maredudd (maredudd800)
Assigned to: Maredudd (maredudd800)
Summary: Document PCC File PRECAMPAIGN tag

Initial Comment:
We have many datasets which either are dependant on another 
dataset to function or conflict with another dataset and should not be 
loaded with it. A prime example are the core datasets and how they 
are configured into Complete and Partial sets, the partial sets should 
not be used when the complete set is loaded and vice versa, also 
the basics partial set is required for all the other Partial sets to 
function. Currently the only way we have to pass this knowledge on 
to the user is with the INFOTEXT tag and hope they can figure it 
out. Thus we propose the PRECAMPAIGN tag:

PRECAMPAIGN:x,y,y

Variable (x): Number (number of items which must match to pass)
Variable (y): Text (Name of a dataset as set by the CAMPAIGN tag)

Primary use: Used as a stand alone tag in .pcc files. Sets specific 
datasets as required or prohibited for the dataset to be loaded. In the 
Source tab a dataset which requires another dataset will appear in 
red until that set is added to the right load pane. When the tag is 
used inversely (i.e. !PRECAMPAIGN) a dataset which prohibits 
itself from being used with another dataset will appear in red when 
that dataset is added to the right load pane. If this same dataset is 
in the right pane when the set it prohibits is added it will be removed 
from the right load pane

Secondary use: A global tag which can be used in any .lst file to 
check for specific datasets. If the set is loaded it passes, if not it 
doesn't.

Examples:

The RSRD Basics Partial set would have:

!PRECAMPAIGN:1,3.5 RSRD

The RSRD Monsters Partial set would have:

PRECAMPAIGN:1,3.5 RSRD Basics
!PRECAMPAIGN:1,3.5 RSRD

Most supplements would use:

PRECAMPAIGN:1,3.5 RSRD,3.5 RSRD Basics

Some campaign set which import core data directly might use:

!PRECAMPAIGN:1,3.5 RSRD,3.5 RSRD Basics

Behavior: as an example I'll use the RSRD Complete, Basics and 
Monster sets. When the complete set is added to the right pane the 
basics and monster sets turn red and cannot be added to the right 
pane. If those sets are already in the right pane when the complete 
set is added they are removed from the load pane. When no sets are 
on the right pane the Monster set appears in red and cannot be 
added because it requires the basic set, it turns black and can be 
added when the basics set is added. The complete set would not 
have any PRECAMPAIGN tags because it is the primar set and 
should trump all others.

The Source Info pane should display the requirements.

----------------------------------------------------------------------

>Comment By: Maredudd (maredudd800)
Date: 2008-08-24 10:52

Message:
Logged In: YES 
user_id=1569765
Originator: YES

Docs reviewed. Tracker to be closed.

----------------------------------------------------------------------

Comment By: Maredudd (maredudd800)
Date: 2008-08-24 00:16

Message:
Logged In: YES 
user_id=1569765
Originator: YES

Docs reviewed. Tracker to be closed.

----------------------------------------------------------------------

Comment By: Maredudd (maredudd800)
Date: 2008-08-23 21:50

Message:
Logged In: YES 
user_id=1569765
Originator: YES

PRECAMPAIGN Docs updated per James' suggestions.

svn #7553

Tracker to be reviewed prior to being closed.

----------------------------------------------------------------------

Comment By: Maredudd (maredudd800)
Date: 2008-08-21 23:40

Message:
Logged In: YES 
user_id=1569765
Originator: YES

Tag added to docs.

svn #7537

Tracker to be reviewed prior to closing.

----------------------------------------------------------------------

Comment By: Maredudd (maredudd800)
Date: 2008-08-21 02:23

Message:
Logged In: YES 
user_id=1569765
Originator: YES

Preliminary entries in.  Some clean up is still required.

svn #7534

----------------------------------------------------------------------

Comment By: Maredudd (maredudd800)
Date: 2008-08-20 17:33

Message:
Logged In: YES 
user_id=1569765
Originator: YES

Added fron Code FREQ [ 2022996 ] Enhance PRECAMPAIGN to use pcc BOOKTYPE
data:

<https://sourceforge.net/tracker/index.php?func=detail&aid=2022996&group_id=25576&atid=384722>

The pcc tag BOOKTYPE will be adopted for use in the PRECAMPAIGN tag.

PRECAMPAIGN will be enhanced to Allow the use of BOOKTYPE data, the
syntax
is:

PRECAMPAIGN:1,BOOKTYPE=x

PRECAMPAIGN will be enhanced to allow the exclusion of specific sets, the
syntax will use brackets around the name, i.e.:

PRECAMPAIGN:1,BOOKTYPE=Core,[3.5 RSRD Basics]

In this example a Core set is required but 3.5 RSRD Basics is not
considered when evaluating. The primary purpose of this is so that a sat
can prohibit other sets of it's same BOOKTYPE without causing itself not
to
pass, thus the 3.5 RSRD Basics set would have:

!PRECAMPAIGN:1,BOOKTYPE=Core,[3.5 RSRD Basics]

This would prohibit other Core sets but not the 3.5 RSRD Basics set
itself
(which would otherwise turn red when added)

BOOKTYPE can be excluded as well. So you could do:

!PRECAMPAIGN:1,BOOKTYPE=Core,[BOOKTYPE=CoreSupplement]


----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=748235&aid=2016671&group_id=25576