diff --git a/viskit/configuration/c_gui.xml b/viskit/configuration/c_gui.xml index b1631937181b261d5356f377740fd252fcd246cd..82bd237367b1ce3966b080275e84e9ca9cfdfcd4 100644 --- a/viskit/configuration/c_gui.xml +++ b/viskit/configuration/c_gui.xml @@ -29,6 +29,9 @@ <projecttitle> <name value="ViskitOpenDis7Examples"/> </projecttitle> - <lookandfeel>platform</lookandfeel> + <!-- macOS works best w/ the platform L&F --> + <lookandfeel>default</lookandfeel> + <!-- WIN machines work best w/ the default L&F in order to get a colorized + status of EG compilation outcomes --> </gui> </ViskitConfig> diff --git a/viskit/doc/ViskitSoftwareDesignSummary.txt b/viskit/doc/ViskitSoftwareDesignSummary.txt index 2b4474445236ab32c3eac5922ab4967c625459e4..308791fac018f6f7ffc80159f2f18559fa37a746 100644 --- a/viskit/doc/ViskitSoftwareDesignSummary.txt +++ b/viskit/doc/ViskitSoftwareDesignSummary.txt @@ -7,20 +7,23 @@ in the "src" directory of the Viskit build. This is accomplished via JAXB. XML bindings help to interface java source with the XML representations of EventGraph and Assembly files. -Next, the main Viskit source is compiled. Viskit can now be launched by typing -"ant quick.run" on the command line. How to use Viskit is explained in the +Next, the main Viskit source is compiled. Viskit can now be launched by typing +"ant quick.run" on the command line. How to use Viskit is explained in the JavaHelp tutorial that can be accessed from Viskit once it's launched by selecting the Help menu, or by launching the help menu via a command line call to "ant help." When Viskit is first launched, it creates a .viskit directory in the ${user.home}. Here, configuration files are placed that can be modified from -Viskit by selecting File -> Settings. Things such as what panels to expose, the +Viskit by selecting File -> Settings. Things such as what panels to expose, the "look and feel" of the UI, size of the UI frame, what project space was last opened, what files were recently opened, and other project history data are -recorded. Various logging output files are also generated and placed there for -later reference should an error have occurred. All of these can be accessed for -content review by running any of the "ant show.*" targets from the command line. +recorded. If note is that macOS works best with the platform L&F while WIN +machines work best with the default L&F. The colorization of EG compilation +status only work on WIN when using the default L&F. Various logging output files +are also generated and placed in a logs directory for later reference should an +error have occurred. All of these can be accessed for content review by running +any of the "ant show.*" targets from the command line. After the .viskit directory is populated, Viskit will popup a dialog to either open an existing Viskit project, create a new one, or exit. A default Viskit @@ -90,11 +93,11 @@ is deleted in order to observe good housekeeping. 3) Next, the project's EventGraphs directory is parsed for the existence of EG XML files. These files are first validated against an EG schema, after which java source is then generated and placed in build/src. The source is then -compiled and the completed byte code is placed in build/classes. Both src and -class directories observe package structures. During the first successful save -of an EG XML file, its MD5 hash is generated a recndorded in the -viskitProject.xml project file along with the path to its generated byte code -(*.class). The build/classes directory is then placed on the live ClassLoader, +compiled and the completed byte code is placed in build/classes. Both src and +class directories observe package structures. During the first successful save +of an EG XML file, its MD5 hash is generated a recndorded in the +viskitProject.xml project file along with the path to its generated byte code +(*.class). The build/classes directory is then placed on the live ClassLoader, the same used to compile these EGs. Simultaneously, when an EG is successfully compiled, its icon symbol is placed @@ -193,14 +196,14 @@ selected from the Assy Editor which fires off a few events: a Thread who's ClassLoader context is separate (new) from the ClassLoader that Viskit is currently running. This is to eliminate any in memory static references to any previously initialized Assembly parameters thereby giving the \ -current Assembly a clean slate to run independently. The main Thread run method -for each XML Assembly file is via subclass of ViskitAssembly which subclasses -BasicAssembly which contains the run method. Subsequent selection of the VCR -run button will produce the exact same results if nothing in the Assy. has been +current Assembly a clean slate to run independently. The main Thread run method +for each XML Assembly file is via subclass of ViskitAssembly which subclasses +BasicAssembly which contains the run method. Subsequent selection of the VCR +run button will produce the exact same results if nothing in the Assy. has been altered. 11) The simulation can be immediately stopped via the VCR stop button, or it can -run until its sim. stop time has expired for the number of replications +run until its sim. stop time has expired for the number of replications selected. Step-through and rewind buttons are implemented, but not working quite right, so, they are disabled upon instantiation from the InternalAssemblyRunner as of now.