From: <mar...@us...> - 2012-11-05 03:08:30
|
Revision: 18156 http://pcgen.svn.sourceforge.net/pcgen/?rev=18156&view=rev Author: maredudd800 Date: 2012-11-05 03:08:22 +0000 (Mon, 05 Nov 2012) Log Message: ----------- Tab Docs update Issue#: DOCS-193 Modified Paths: -------------- Trunk/pcgen/docs/images/tabs/inventorytab/tab_inventory_00_customizer.png Trunk/pcgen/docs/images/tabs/inventorytab/tab_inventory_01_container.png Trunk/pcgen/docs/images/tabs/inventorytab/tab_inventory_01_equipselection.png Trunk/pcgen/docs/tabpages/tabcharactersheet.html Trunk/pcgen/docs/tabpages/tabinventory.html Trunk/pcgen/docs/tabpages/tabraces.html Added Paths: ----------- Trunk/pcgen/docs/images/tabs/inventorytab/tab_inventory_00_purchase.png Trunk/pcgen/docs/images/tabs/inventorytab/tab_inventory_01_equipment.png Removed Paths: ------------- Trunk/pcgen/docs/images/tabs/inventorytab/tab_inventory_00_purchase.png Trunk/pcgen/docs/images/tabs/inventorytab/tab_inventory_01_equipment.png Modified: Trunk/pcgen/docs/images/tabs/inventorytab/tab_inventory_00_customizer.png =================================================================== (Binary files differ) Deleted: Trunk/pcgen/docs/images/tabs/inventorytab/tab_inventory_00_purchase.png =================================================================== (Binary files differ) Copied: Trunk/pcgen/docs/images/tabs/inventorytab/tab_inventory_00_purchase.png (from rev 18149, Trunk/pcgen/docs/images/tabs/inventorytab/tab_inventory_01_equipment.png) =================================================================== (Binary files differ) Modified: Trunk/pcgen/docs/images/tabs/inventorytab/tab_inventory_01_container.png =================================================================== (Binary files differ) Deleted: Trunk/pcgen/docs/images/tabs/inventorytab/tab_inventory_01_equipment.png =================================================================== (Binary files differ) Copied: Trunk/pcgen/docs/images/tabs/inventorytab/tab_inventory_01_equipment.png (from rev 18149, Trunk/pcgen/docs/images/tabs/inventorytab/tab_inventory_00_purchase.png) =================================================================== (Binary files differ) Modified: Trunk/pcgen/docs/images/tabs/inventorytab/tab_inventory_01_equipselection.png =================================================================== (Binary files differ) Modified: Trunk/pcgen/docs/tabpages/tabcharactersheet.html =================================================================== --- Trunk/pcgen/docs/tabpages/tabcharactersheet.html 2012-11-04 23:20:11 UTC (rev 18155) +++ Trunk/pcgen/docs/tabpages/tabcharactersheet.html 2012-11-05 03:08:22 UTC (rev 18156) @@ -25,57 +25,47 @@ <h1>Character Sheet Tab</h1> - <p>The Character Sheet Tab is a new feature making it's debut in version 5.13.2. - The Character Sheet Tab is similar to the Preview tab and it's purpose is the - same: to display your characters information. The difference between the Preview - Tab and the Character Sheet Tab is that the Preview Tabs layout is coded in - java and can't be adjusted except by editing the code and recompiling the - program. The Character Sheet Tab uses html to render its display, this means - that the sheets can be edited with a text editor while the program is running - and they can be created and altered by anyone with a little knowledge of html - and OS tokens. The html output sheets used for output can be used in the Character - Sheet Tab, in fact most of the sheets available are simply duplicates of the - output sheets. </p> + <p>The <strong>Character Sheet</strong> tab is used to review and preview characters created by PCGen.</p> - <p>Changes made to the character in PCGen are updated automatically in the Character - Sheet Tab at the time you make them. So, for example, if you were to apply the - Rage bonuses from the Temporary Bonus Tab you would see these changes applied - to your character when you returned to the Character Sheet Tab.</p> - - <p class="center"><img src="../images/tabs/charactersheettab/tab_charsheet_00.png" alt="Character Sheet Tab"></p> - - <p>The Character Sheet Tab has an additional pane on the right which can be accessed - by clicking the arrow along the vertical border of the window. This pane displays - the Character Sheet selection menu, the Equipsets and a list of temporary bonuses - which have been applied to the PC. The Character Sheet selection menu enables - you to select a sheet from a list of sheets available for the currently active - gameMode. The radio button beside each Equipset indicates which Equipset is - currently being applied to the PC and displayed in the Character Sheet Tab. - You can switch to another Equipset by simply clicking on the corresponding radio - button. Each temporary bonus has a check box on it's left which indicate if - it is active or not. Temporary bonuses can be switched off and on with the check - box which will update the output of the Character Sheet tab.</p> - <p class="center"><img src="../images/tabs/charactersheettab/tab_charsheet_01_closedleft.png" alt="Character Sheet Tab"></p> + <p>The <strong>Character Sheet</strong> tab uses html to render its display, this means that the sheets can be + edited with a text editor while the program is running and they can be created and altered by anyone with a + little knowledge of html and the OS tokens. The html output sheets used for output can be used in the + <strong>Character Sheet</strong> tab.</p> + + <p>Changes made to the character in PCGen are updated automatically on the <strong>Character Sheet</strong> + as they are made. As an example, if the Rage bonuses (3.5e and Pathfinder gameModes) are applied on the + <strong>Temporary Bonuses</strong> tab, the character displayed on the <strong>Character Sheet</strong> + tab would bonuses will be updated to include those bonuses the next time the user returns to the + <strong>Character Sheet</strong> tab.</p> - <p class="center"><img src="../images/tabs/charactersheettab/tab_charsheet_02_sheetselection.png" alt="Character Sheet Selectio"></p> + <p class="center"><img src="../images/tabs/charactersheettab/tab_charsheet_00.png" alt="Character Sheet Tab"></p> + <p>The Character Sheet Tab has an additional pane on the left which can be accessed by clicking the + arrow along the vertical border of the window. This pane displays the Character Sheet selection + menu, the Equipsets and a list of temporary bonuses which have been applied to the PC. The Character + Sheet selection menu enables the user to select a sheet from a list of sheets available for the + currently active gameMode. The radio button beside each Equipset indicates which Equipset is + currently being applied to the PC and displayed in the Character Sheet Tab. You can switch to + another Equipset by simply clicking on the corresponding radio button. Each temporary bonus has + a check box on it's left which indicate if it is active or not. Temporary bonuses can be switched + off and on with the check box which will update the output of the Character Sheet tab.</p> + + <p class="center"><img src="../images/tabs/charactersheettab/tab_charsheet_02_sheetselection.png" alt="Character Sheet Selection"></p> + <h2>Configuration</h2> - <p>All the sheets used by the Character Sheet Tab can be found in the pcgen/preview - directory. Each gameMode has a specific directory of sheets which is set in - the gameModes miscinfo.lst file with the - <a href="../listfilepages/systemfilestagpages/gamemodemiscinfolist.html#PREVIEWDIR">PREVIEWDIR</a> - tag. Each gameMode also has a default sheet set by the - <a href="../listfilepages/systemfilestagpages/gamemodemiscinfolist.html#PREVIEWSHEET">PREVIEWSHEET</a> - miscinfo.lst file.</p> + <p>All the sheets used by the <strong>Character Sheet</strong> tab can be found in the <span class="lstfile">pcgen/preview</span> + directory. Each gameMode has a specific directory of sheets which is set in the gameModes <span class="lstfile">miscinfo.lst</span> + file with the <a href="../listfilepages/systemfilestagpages/gamemodemiscinfolist.html#PREVIEWDIR">PREVIEWDIR</a> tag. Each gameMode + also has a default sheet set by the <a href="../listfilepages/systemfilestagpages/gamemodemiscinfolist.html#PREVIEWSHEET">PREVIEWSHEET</a> + tag in the gameModes <span class="lstfile">miscinfo.lst</span> file.</p> - <p>Character Sheets can contain images, the paths to the images must use the - pcgen directory as its root.</p> + <p>Character Sheets can contain images, the paths to the images must use the pcgen directory as its root.</p> - <p>Character Sheets can utilize Javascript. Check out the preview.html sheet for - examples of what can be accomplished by javascript savvy coders.</p> + <p>Character Sheets can utilize Javascript. Check out the <scan class="lstfile">preview.html</scan> sheet for examples + of what can be accomplished by javascript savvy coders.</p> <hr> Modified: Trunk/pcgen/docs/tabpages/tabinventory.html =================================================================== --- Trunk/pcgen/docs/tabpages/tabinventory.html 2012-11-04 23:20:11 UTC (rev 18155) +++ Trunk/pcgen/docs/tabpages/tabinventory.html 2012-11-05 03:08:22 UTC (rev 18156) @@ -17,7 +17,7 @@ --> <head> <title>Inventory Tab</title> - <link rel="stylesheet" type="text/css" href="../../../pcgen.css"> + <link rel="stylesheet" type="text/css" href="../pcgen.css"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> </head> @@ -36,97 +36,111 @@ <h2><a name="purchase">Purchase Sub-Tab</a></h2> + <p>This sub-tab allows the purchasing and selling of equipment including armor, shields, weapons, and other equipment of all types.</p> + <p class="center"><img src="../images/tabs/inventorytab/tab_inventory_00_purchase.png" alt="Inventory Purchase Sub-Tab" /></p> - <p>This sub-tab allows the purchasing and selling of armor, items, shields and weapons.</p> - <p>The left pane includes items that can be bought or customized. The "Available" drop-down menu lets you choose how to list the items.</p> - <p>The right pane includes the items your character currently has. If you right-click any of the items there you will get the option to "Move To" and "Copy To". Under each option there is a listing of all the other currently-loaded characters. You can then either move the item (sending the selected item to the selected character and removing it from the current character's list of equipment) or copy it (send a copy of the item to the selected character).</p> - <p>The "Order" column dictates the order the items get output to the character output sheet (only equipped items get output to the output sheets).</p> + <p>The left pane includes items that can be bought or customized while the right pane shows the items already purchased or owned.</p> + + <p>Items in the left pane that appear in red are items that the character does not have proficiency in. These items may be removed + from the list by clicking on the <strong>Qualified</strong> button. Clicking on the <strong>Affordable</strong> button will + further reduce the list of items, removing items that the current character cannot afford. This will be done even if the Buy/Sell + Rate is changed to "Cashless - Buy 0 Sell 0"</p> + + <p class="center"><img src="../images/tabs/inventorytab/tab_inventory_00_search.png" alt="Item Search" /></p> + + <p>The list of items in the left pane is long but can be shorted by entering the name of the piece of equipment being + sought. The list of available equipment will change as the items name is entered, narrowing the list of equipment + as you go.</p> + + <p>Items can be purchased by: + <ul> + <li>Selecting the item in the left frame and then clicking the <strong>Add Equipment ></strong> button</li> + <li>Double Clicking the item in the left frame</li> + <li>Right clicking the item in the left frame and buying 1, 5, 10, 20 or n (user entered quantity) at a time</li> + </ul> + </p> + + <p>Items can be sold by: + <ul> + <li>Selecting the item in the right frame and then clicking the <strong>< Remove Equipment</strong> button</li> + <li>Double Clicking the item in the right frame</li> + <li>Right clicking the item in the right frame and selling 1, 5, 10, 20 or n (user entered quantity) at a time</li> + </ul> + </p> + + <p>If you right-click any of the items there you will get a drop-down menu of options available for that item, + including the following: + <ul> + <li>The <strong>Move Item To</strong> option provides a list of all characters currently loaded and then moves the item to the character selected.</li> + <li>The <strong>Copy Item To</strong> option provides a list of all characters currently loaded and then moves a copy of the item to the character selected.</li> + <li>The <strong>Modify Charges</strong> option allows you to modify the number of charges left on a charged item, e.g. magic wand or staff.</li> + </ul> + </p> - <p>Items can be purchased by:</p> - <ul> - <li>Selecting the item in the left frame and then clicking the ">" (Add) - button</li> - <li>Selecting the item in the left frame and then pressing <strong>Ctrl><=></strong></li> - <li>Double Clicking the item in the left frame</li> - <li>Right clicking the item in the left frame and buying 1, 5, 10, 20 or n (user entered quantity) at a time</li> - </ul> + <p>As you purchase or sell items you will see the amount of money you have available in the lower left frame diminish + or increase as appropriate by an amount equal to the price of the item multiplied by the <strong>Buy/Sell Rate</strong></p> - <p>As you purchase items you will see the amount of money you have available in the lower right frame diminishes. - The amount deducted is the price multiplied by the <strong>Buy Percentage</strong></p> + <p>You can modify this total by entering a value in the <strong>Add or Subtract Funds</strong> field.</p> - <p>Items can be sold by:</p> - <ul> - <li>Selecting the item in the right frame and then clicking the "<" (Remove) - button</li> - <li>Selecting the item in the right frame and then pressing <strong>Ctrl><-></strong></li> - <li>Double Clicking the item in the right frame</li> - <li>Right clicking the item in the right frame and selling 1, 5, 10, 20 or n (user entered quantity) at a time</li> - </ul> - - <p>As you sell items you will see the amount of money you have available in the lower right frame increases. - The amount added is the price multiplied by the <strong>Sell Percentage</strong></p> - - <p>You can modify this total by editing the <strong>Gold:</strong> field.</p> - <p>The <strong>Allow Debt</strong> option enables PCGen to allow negative gold amounts to represent what the Character owes.</p> <p>The <strong>Ignore Cost</strong> option allows items to be added or removed without effecting the gold value.</p> - <p>Pressing <strong><Ctrl><f></strong> or using the right click menu's <strong>Find - item</strong> option allows for searching for items. The nearest match in the item list will be highlighted.</p> - - <p class="center"><img src="../images/windows/find_item.png" alt="Item Search" /></p> - - <p>The charges a wand or similar item has left can be modified after purchasing the item by right clicking it in - the right window and choosing <strong>Modify Charges</strong>.</p> - - <p class="center"><img src="../images/tabs/inventorytab/tab_inventory_00_modifycharges.png" alt="Modify Charges" /></p> - - <h3>Creating Masterwork/Magical/Sizing Items</h3> - <p>To make an item Masterwork, Magical or change its properties (like take a - regular set of plate mail and make it small-sized for a small sized PC), right - click on it and choose <strong>Create custom item</strong>.</p> + <p>To make an item Masterwork, Magical or change its properties (like take a regular set of plate mail and make it small-sized + for a small sized PC), right click on it and choose <strong>Create custom item</strong>.</p> <p><strong>Note:</strong> The item needs to be "Masterwork" if a magical item is to be created.</p> - <p class="center"><img src="../../images/tabs/inventorytab/tab_inventory_00_customizer.png" alt="Item Customizer" /></p> + <p class="center"><img src="../images/tabs/inventorytab/tab_inventory_00_customizer.png" alt="Item Customizer" /></p> <p>To add new properties to the item, select them from the left hand pane and either double click or click the <strong>Add</strong> button. If the Property prerequisites are not met, it is shown in the default error color and it cannot be added. </p> - <p>Other than properties, the following can be modified:</p> + <p>Other than properties, the following can be modified: + <ul> + <li><strong>Name</strong> - The name that will be displayed in the item list</li> + <li><strong>Sprop</strong> - Any special properties that the item has</li> + <li><strong>Cost</strong> - The purchase cost of the item</li> + <li><strong>Weight</strong> - The weight of the item</li> + <li><strong>Damage</strong> - The damage that the weapon does</li> + </ul> + </p> - <ul> - <li><strong>Name</strong> - The name that will be displayed in the item list</li> - <li><strong>Sprop</strong> - Any special properties that the item has</li> - <li><strong>Cost</strong> - The purchase cost of the item</li> - <li><strong>Weight</strong> - The weight of the item</li> - </ul> + <p>Once all properties have been selected, you can click <strong>OK</strong> to add it to the item list, <strong>Buy</strong> + to add it to the item list and add it to the characters possessions, or <strong>Cancel</strong> to close the customizer + window without adding the customized item to either the list or to the character.</p> - <p>Once all properties have been selected, you can either choose <strong>OK</strong> to add it to the item list or <strong>Buy</strong> - to add it to the item list and add it to the characters possessions</p> - <hr> <h2><a name="equipment">Equipment Sub-Tab</a></h2> - <p class="center"><img src="../images/tabs/inventorytab/tab_inventory_01_equipment.png" alt="Inventory Equipping Sub-Tab" /></p> - - <p>The <strong>Equipment</strong> sub-tab helps you organize the gear your character owns as well as determining which weapons and armor - are used and in what hands. This sub-tab allows the gear that was purchased to be equipped to the character. The pane on the upper-left - contains the items that your character has purchased and the right pane shows the equipment that has been "equipped" as well - as the location to which the gear has been equipped. You equip gear by selecting an item from the left hand frame and double clicking - on it or clicking on the <strong>Equip Selected ;></strong> button at the bottom right of the pane.</p> + <p>This sub-tab allows the Gear that was purchased to be equipped to the character.</p> <p class="center"><img src="../images/tabs/inventorytab/tab_inventory_01_equipment.png" alt="Equipping Gear" /></p> - <p>This Sub-tab allows the Gear that was purchased to be equipped to the character.</p> + <p>The <strong>Equipment</strong> sub-tab helps you organize the gear your character owns as well as determining which + weapons and armor are used and in what hands. This sub-tab allows the gear that was purchased to be equipped to the + character. The pane on the upper-left contains the items that your character has purchased and the right pane shows + the equipment that has been "equipped" and where it has been equipped.</p> + <p>You equip gear by selecting an item from the left pane and clicking on the <strong>Equip Selected ></strong> button + at the bottom right of the pane.</p> + + <p class="center"><img src="../images/tabs/inventorytab/tab_inventory_01_equipselection.png" alt="Equip Selection" /></p> + + <p>Weapons can be equipped as Single Handed, Two Handed and Both Hands. The equipped style determines what bonuses/penalties + apply. Weapons that are carried will appear on the character sheet in the weapons section.</p> + + <p class="center"><img src="../images/tabs/inventorytab/tab_inventory_01_container.png" alt="Equipping to a Container" /></p> + + <p>Some items are containers and can hold other items. This can be done by "equipping" the items to the containers + directly.</p> + <p class="center"><img src="../images/tabs/inventorytab/tab_inventory_01_equipsets.png" alt="Equipment Sets" /></p> <p>It also allows the creation of multiple equipment sets so you can print output sheets based on different weapon, @@ -140,16 +154,6 @@ every item your character is carrying should be marked as "Carried" so your character's encumbrance will be figured correctly.</p> - <p class="center"><img src="../images/tabs/inventorytab/tab_inventory_01_equipselection.png" alt="Equip Selection" /></p> - - <p>Weapons can be equipped as Single Handed, Two Handed and Both Hands. The equipped style determines what bonuses/penalties - apply. Weapons that are carried will appear on the character sheet in the weapons section.</p> - - <p class="center"><img src="../images/tabs/inventorytab/tab_inventory_01_container.png" alt="Equipping to a Container" /></p> - - <p>Some items are containers and can hold other items. This can be done by "equipping" the items to the containers - directly.</p> - <p>Every item your character is carrying should be marked "Carried" so your encumbrance will be figured correctly. You can add additional equipment sets by typing in the name of an equipment set and clicking on the Add button (in the Upper right hand frame).</p> Modified: Trunk/pcgen/docs/tabpages/tabraces.html =================================================================== --- Trunk/pcgen/docs/tabpages/tabraces.html 2012-11-04 23:20:11 UTC (rev 18155) +++ Trunk/pcgen/docs/tabpages/tabraces.html 2012-11-05 03:08:22 UTC (rev 18156) @@ -17,19 +17,17 @@ --> <head> <title>Races Tab</title> - <link rel="stylesheet" type="text/css" href="../../pcgen.css"> + <link rel="stylesheet" type="text/css" href="../pcgen.css"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> </head> <body> <h1>Races Tab</h1> + <p>The <strong>Races</strong> tab is where you select your race.</p> + <p class="center"><img src="../images/tabs/racestab/tab_race_00.png" alt="Main Tab: Races" /></p> - <p> The Race tab is where you select your race (you can only have 1!), and where - you can pick any templates that apply to your character. It is divided into - two sub-tabs: Races and Templates.</p> - <p> Sort Races (Drop Down Menu) - There are 3 ways you can categorize the Races:</p> <ul> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |