[Pcgen-team-content] [JIRA] Created: (DOCS-74) Identify Template Token Consolidation Rules

[JIRA (f. D. R. B. ) <ji...@pc...>]

Identify Template Token Consolidation Rules
-------------------------------------------

                 Key: DOCS-74
                 URL: http://jira.pcgen.org/browse/DOCS-74
             Project: Documentation
          Issue Type: New Feature
          Components: Data/LST
    Affects Versions: 5.16.4
            Reporter: David R. Bender
             Fix For: 6.0.x


SF ID: 2643995

Overwriting Tokens (those where:
Thing <> TOKEN:A
Thing.MOD <> TOKEN:B
results in "B")

SIZE
REMOVABLE
REGION
REACH
VISIBLE
RACETYPE
NONPP
LEVELADJUSTMENT
HITDIE
LEGS
HANDS
GENDERLOCK
CR
FACE
FAVOREDCLASS
BONUSSKILLPTS

Appending Tokens (those where:
Thing <> TOKEN:A
Thing.MOD <> TOKEN:B
is equivalent to TOKEN:A,B [*note , may be a different separator based on
the token - the theory is what holds here, please be cognizant of an
individual token's syntax when building specific examples] )
(This also implies (and it may be useful to document) that some form of
.CLEAR [* note again, caveat here on exact syntax in any token, e.g. may be
.CLEARALL or may not be available at all] is necessary to reset the
"list")

WEAPONBONUS
LANGBONUS
SUBREGION
SUBRACE
RACESUBTYPE

Separate Tokens (those where:
Thing <> TOKEN:A
Thing.MOD <> TOKEN:B
is equivalet to:
Thing <> TOKEN:A <> TOKEN:B
but NOT equivalent to:
Thing <> TOKEN:A,B
)
[*note , may be a different separator based on the token and may not be
available at all in some separate tokens - the theory is what holds here,
please be cognizant of an individual token's syntax when building specific
examples]
(This also implies (and it may be useful to document) that some form of
.CLEAR [* note again, caveat here on exact syntax in any token, e.g. may be
.CLEARALL or may not be available at all] is necessary to reset the
"list")

LEVEL
HD
REPEATLEVEL
ADDLEVEL

The following tokens are currently problematic, not to be handled as part
of this tracker:

FEAT
Submitted:

Tom Parker ( thpr ) - 2009-02-26 22:02:21 EST 

Date: 2009-04-13 23:32:31 EDT
Sender: maredudd800Project Admin
Hide

FAVOREDCLASS is appended when consolidated.

Appending tags complete.
Over writing tags complete through LEVELADJUSTMENT.
Separate tags complete.

5.16.0 svn #9837
Trunk svn #9838


Date: 2009-04-13 22:43:58 EDT
Sender: maredudd800Project Admin
Hide

The following text is taken from an irc discussion I had with Tom
concerning the .MOD consolidation rules for the Template file tags:
[Arch_SB]thpr I guess my recommendation would be this:
[Arch_SB]thpr if you run into anything that claims to append but the docs
dont' have a separator character
[Arch_SB]thpr be concerned
[Arch_SB]thpr if you run into anything that claims to overwrite but the
docs do list a separator
[Arch_SB]thpr be concerned
[Arch_SB]thpr except: UDAM, CAST, KNOWN, SPECIALITYKNOWN will overwrite
[Arch_SB]thpr even though they have separator characters
[Arch_SB]thpr alternately
[Arch_SB]thpr you can check them yourself :)
[Arch_SB]thpr if you go into the token code in plugin.lsttokens
[Arch_SB]thpr it should be pretty straightforward as to which tokens are
which names
[Arch_SB]thpr ObjectKey will indicate overwriting
[Arch_SB]thpr ListKey generally is appending (with the exceptions listed
above)
[Arch_SB]thpr though ListKey can also be separate
[Arch_SB]thpr difference in those is found in unparse
[Arch_SB]thpr separate items will put into a List or Set and then do a
.toArray on the List or Set
[PR_SB]Maredudd Got it. I can do that check as I go through them. I can
read that much code . . . :-)
[Arch_SB]thpr appending items will use a StringBuilder or will call
StringUtil.join() or ReferenceUtilities.join() on the List or Set
[Arch_SB]thpr keep track of the ones that aren't somewhat obvious and I
can double check them if you drop me a ntoe
[Arch_SB]thpr oh and StringKey and IntegerKey are also overwriting
[Arch_SB]thpr MApKey items are selectively overwriting
[Arch_SB]thpr (e.g. ASPECT)
[Arch_SB]thpr that will handle all but a handful of tokens


Date: 2009-04-13 22:33:16 EDT
Sender: maredudd800Project Admin
Hide

SUBREGION and SUBRACE are overwriting tags, not appending tags.


Date: 2009-03-01 17:45:08 EST
Sender: maredudd800Project Admin
Hide

Partial completion on this tracker.

Tom, take a look at the Template File docs and let me know if I am
tackling this in the way you envisioned.



-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.pcgen.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira