LST Editor - Revision history

James at 21:59, 13 January 2010

2010-01-13T21:59:53Z

MotorViper at 14:50, 13 January 2010

2010-01-13T14:50:46Z

James at 02:30, 10 January 2010

2010-01-10T02:30:20Z

Maredudd at 15:21, 17 December 2009

2009-12-17T15:21:23Z

Karianna: /* Use */

2009-12-17T11:38:16Z

‎Use

Karianna: /* Use */

2009-12-17T11:37:59Z

‎Use

Karianna: /* Use */

2009-12-17T11:37:38Z

‎Use

Karianna: /* Introduction */

2009-12-17T11:36:21Z

‎Introduction

Karianna at 11:35, 17 December 2009

2009-12-17T11:35:29Z

Karianna: /* Introduction. */

2009-12-10T14:17:30Z

‎Introduction.

@@ Line 40: / Line 40: @@
 * If there is no pcc file given then it will be blank.
 * If a pcc file is given and no object type selected then all the lst files currently associated with that file are available plus 'new' and 'all'.
-* If a object type is selected then the list of files associated with the pcc file that can contain that object, plus 'new' and 'all' are available.
+* If an object type is selected then the list of files associated with the pcc file that can contain that object, plus 'new' and 'all' are available.
 * The save button saves the data in the selected tab.
 * If the lst file selected is 'new' then the user is asked for a file name to save the data in, the user is also asked if the file should be added to the pcc file.
-== Tab 1 ==
+== Tab 1 - Object Selection ==
 [[File:LST_Editor_Tab1.jpg]]
@@ Line 65: / Line 65: @@
 * Note if the PCC entry is selected in the object list then processing is different as this refers to the pcc file, not a lst file. In this case the lst file area is disabled changes will be made to the pcc file.
-== Tab 2 ==
+== Tab 2 - Tag Entry ==
 [[File:LST_Editor_Tab2.jpg]]
@@ Line 90: / Line 90: @@
 * When the save button is hit the file will be parsed and if it fails the user will be warned of this and asked if the file should still be saved. This allows partially completed updates to be saved.
-== Tab3 ==
+== Tab3 - Editor ==
 [[File:LST_Editor_Tab3.jpg]]

@@ Line 9: / Line 9: @@
 ==State==
-* Currently the editor for LST files built into PCGen is in need of a rebuild. It has some issues and doesn't expand itself when new tokens are added (because it's hard coded from before there were LST tokens).  It also has problems with certain tokens.
+* Currently the editor for LST files built into PCGen is in need of a rebuild. It has some issues and doesn't expand itself when new objects are added (because it's hard coded from before there were LST objects).  It also has problems with certain objects.
 ==Project Goals==
-* Any new token would at least give a text field, even if PCGen didn't recognize the token.
+* Any new object would at least give a text field, even if PCGen didn't recognize the object.
 * Allows edit both during runtime (meaning you can copy existing objects, but can't modify the ones that already exist) and in a "edit in place" mode (allow editing of the LST files in full, as a stand-alone program, vs. embedded in PCGen).
@@ Line 19: / Line 19: @@
 == Overview ==
-The user interface is able to be run in stand-alone mode or inside PCGEN. More than one instance can be run at a time to allow copying/inspection of data. If the editor is run from within PCGEN then it's title bar indicates this plus there is a different colour border around the tabbed area to indicate this.
+The user interface is able to be run in stand-alone mode or inside PCGEN. More than one instance can be run at a time to allow copying/inspection of data. If multiple instances are running then only the first will be editable. If the editor is run from within PCGEN then it's title bar indicates this plus there is a different colour border around the tabbed area to indicate this.
 == Dialog ==
@@ Line 39: / Line 39: @@
 * If there is no pcc file given then it will be blank.
-* If a pcc file is given and no primary token selected then all the lst files currently associated with that file are available plus 'new' and 'all'.
+* If a pcc file is given and no object type selected then all the lst files currently associated with that file are available plus 'new' and 'all'.
-* If a primary token is selected then the list of files associated with the pcc file that can contain that token, plus 'new' and 'all' are available.
+* If a object type is selected then the list of files associated with the pcc file that can contain that object, plus 'new' and 'all' are available.
 * The save button saves the data in the selected tab.
 * If the lst file selected is 'new' then the user is asked for a file name to save the data in, the user is also asked if the file should be added to the pcc file.
@@ Line 46: / Line 46: @@
 == Tab 1 ==
-[[File:LST_Editor_Tab1.jpg‎]]
+[[File:LST_Editor_Tab1.jpg]]
-The primary token tab consists of three parts:
+The object type tab consists of three parts:
-# The main token area: this lists all the top level tokens in the system.
+# The main object area: this lists all the top level objects in the system.
 # The item selection area: this allows the user to select an item to edit.
 # The new entry button.
@@ Line 56: / Line 56: @@
 === Use ===
-* The contents of the main token area are fixed. The full list of top level tokens will be visible.
+* The contents of the main object area are fixed. The full list of top level objects will be visible.
 * The contents of the item selected area is determined by the other areas.
 * If no lst file or 'new' is chosen then it is empty.
-* If a lst file is chosen then all entries in that file of the primary token selected  are visible.
+* If a lst file is chosen then all entries in that file of the object type selected  are visible.
-* If no primary token is selected then all entries in the file are visible.
+* If no object type is selected then all entries in the file are visible.
 * Double clicking or CTRL-Right will move focus to tab 2 with that entry selected.
-* The new entry button is only available if a primary token is selected and a lst file other than 'all' is selected.
+* The new entry button is only available if a object type is selected and a lst file other than 'all' is selected.
-* Note if the PCC entry is selected in the token list then processing is different as this refers to the pcc file, not a lst file. In this case the lst file area is disabled changes will be made to the pcc file.
+* Note if the PCC entry is selected in the object list then processing is different as this refers to the pcc file, not a lst file. In this case the lst file area is disabled changes will be made to the pcc file.
 == Tab 2 ==
-[[File:LST_Editor_Tab2.jpg‎]]
+[[File:LST_Editor_Tab2.jpg]]
-The secondary token tab consists of 7 parts:
+The secondary object tab consists of 7 parts:
-# The primary token area: this gives the token type and name as selected in tab 1.
+# The object type area (Ability in the example above): this gives the object type and name as selected in tab 1.
-# The secondary token area: this lists all the secondary tokens types associated with the primary one, it also includes a value of 'all' so that all the tokens can be seen.
+# The objects area: this lists all the objects associated with the object type, it also includes a value of 'all' so that all the tags can be seen.
-# The secondary token list: this lists all the secondary tokens of the selected type associated with the primary token.
+# The tag list: this lists all the tags of the selected object associated with the object type.
-# The editor area: this allows input of the data associated with the secondary token.
+# The editor area: this allows input of the data associated with the tag.
-# Add button: for adding new secondary tokens.
+# Add button: for adding new tags.
 # Parse button: for parsing the input.
-# The message area: this will display any messages associated with parsing the token.
+# Auto Parse check box: When this is checked the current token is parsed as it is edited.
 === Use ===
-* The contents of the primary and secondary token areas are determined by what is selected in tab 1.
+* The contents of the primary and secondary object areas are determined by what is selected in tab 1.
-* The secondary token list contains the actual data associated with the secondary token selected.
+* The secondary object list contains the actual data associated with the secondary object selected.
-* The editor area is initially a text field but for some tokens, e.g. an integer token, a smart editor appears here.
+* The editor area is initially a text field but for some objects, e.g. an integer object, a smart editor appears here.
-* The add button is only enabled if there is no current token of the selected type or multiple tokens of that type can be used and 'all' is not the selected type.
+* The add button is only enabled if there is no current object of the selected type or multiple objects of that type can be used and 'all' is not the selected type.
-* When the data is parsed the message area shows any errors from the parsing. Double clicking on an error give the errant token focus.
+* When the data is parsed the message area shows any errors from the parsing. Double clicking on an error give the errant object focus.
-* After parsing each token which is in error will also be coloured red in the list so that it is quick to see where problems lie.
+* After parsing each object which is in error will also be coloured red in the list so that it is quick to see where problems lie.
 * When the save button is hit the file will be parsed and if it fails the user will be warned of this and asked if the file should still be saved. This allows partially completed updates to be saved.
 == Tab3 ==
-[[File:LST_Editor_Tab3.jpg‎ ]]
+[[File:LST_Editor_Tab3.jpg]]
 The editor tab is an editable area, this has standard text editing abilities, e.g. copy, cut and paste, search and replace. This area also has some smart editing features, though not as powerful as the editor area in tab 2. If an item is selected CTRL-Left on the item will move focus to tab 2 with that entry selected, it will also populate tab 1 accordingly. The file in this editor will be that in area 3 of the first tab.

@@ Line 95: / Line 95: @@
 The editor tab is an editable area, this has standard text editing abilities, e.g. copy, cut and paste, search and replace. This area also has some smart editing features, though not as powerful as the editor area in tab 2. If an item is selected CTRL-Left on the item will move focus to tab 2 with that entry selected, it will also populate tab 1 accordingly. The file in this editor will be that in area 3 of the first tab.
-= Interaction between areas =
+=== Interaction between areas ===
 The editor shows the contents of the selected lst file or pcc file. The switch button will change it's text according to whether the pcc file or lst file is displayed. The reload button reloads the file and so can be used to undo changes that have not been saved.

@@ Line 9: / Line 9: @@
 ==State==
-* Currently the editor for LST files built into PCGen is a in need of a rebuild. It has some issues and doesn't expand itself when new tokens are added (because it's hard coded from before there were LST tokens).  It also has problems with certain tokens.
+* Currently the editor for LST files built into PCGen is in need of a rebuild. It has some issues and doesn't expand itself when new tokens are added (because it's hard coded from before there were LST tokens).  It also has problems with certain tokens.
 ==Project Goals==

@@ Line 41: / Line 41: @@
 * If a pcc file is given and no primary token selected then all the lst files currently associated with that file are available plus 'new' and 'all'.
 * If a primary token is selected then the list of files associated with the pcc file that can contain that token, plus 'new' and 'all' are available.
+* The save button saves the data in the selected tab.
 * If the lst file selected is 'new' then the user is asked for a file name to save the data in, the user is also asked if the file should be added to the pcc file.

@@ Line 5: / Line 5: @@
 =Introduction=
-The LST editor for PCGEN is designed to make the editing of LST files, the data files that determine how PCGEN works, easy.
+The LST editor for PCGEN is designed to simplify the editing of LST files which are the data files that determine how PCGEN works.
 ==State==

← Older revision		Revision as of 11:35, 17 December 2009
Line 1:		Line 1:
−	~~'''LST Editor'''~~	+	{\| align="right"
		+	\| __TOC__
		+	\|}

	=Introduction=		=Introduction=

@@ Line 1: / Line 1: @@
 '''LST Editor'''
-= Introduction. =
+=Introduction=
 The LST editor for PCGEN is designed to make the editing of LST files, the data files that determine how PCGEN works, easy.
 = User Interface =