Recent changes to Home

Home modified by Peter Vranken

Peter Vranken — Wed, 05 Oct 2022 12:44:55 -0000

--- v7
+++ v8
@@ -1,4 +1,4 @@
-[[include repo=comframe:code path=excelExporter/trunk/doc/readMe.md]]
+[[include repo=comframe:code path=excelExporter/trunk/readMe.md]]
 ## Download ##
 [[download_button]]

Home modified by Peter Vranken

Peter Vranken — Mon, 21 Mar 2016 21:04:32 -0000

--- v6
+++ v7
@@ -1,182 +1,4 @@
 [[include repo=comframe:code path=excelExporter/trunk/doc/readMe.md]]
---------------------------------
-# excelExporter - Rendering Excel Spreadsheets as Text #
-
-## Introduction ##
-
-This archive contains the binary distribution of excelExporter, an
-application that can translate the information found in one or more Excel
-workbooks into manyfold textual representations. excelExporter is a
-general purpose text rendering application for Excel spreadsheets.
-
-excelExporter is the auxiliary code generator from the
-[comFramework](http://sourceforge.net/p/comframe/wiki/Home/
-"Sourceforge repository of comFramework") project. However, the use of
-excelExporter is in no way restricted to the context of CAN interface
-generation in embedded, automotive software development. Because of its
-generality we decided to publish it as independent Sourceforge project.
-This relates to the binaries and the documentation. The source code and
-the build scripts remain part of project comFramework; some of the links
-down here will thus point to that other project.
-
-The principal aim of the tool is supporting automation tasks in software
-development environments. In the context of the comFamework project this
-targets the handling of data dictionaries and interfaces but excelExporter
-is by design independent from this intented purpose and will be useful for
-various other automation tasks.
-
-You can render the information in the Excel input for example as:
-
-- HTML or LaTeX for documentation
-- Various XML formats for interfacing with other applications
-- C/C++ or any other textual programming languages
-
-In- and output description are decoupled in the parametrization of the
-tool. First you will specify a set of Excel input files. All of these are
-parsed and merged to one large data structure, ofter refered to as _data
-model_. Input files of same or of different format are supported.
-("Format" refers to the structure of the Excel files with respect to
-contained sheets and columns.)
-
-Secondary, you will define a list of output files. The specification of
-each output file is associated with the specification of a StringTemplate
-V4 template file. The template controls the output generation and this is
-how the same information is rendered once as HTML code and once as - for
-example - C program fragment.
-
-
-## Documentation ##
-
-### Command line interface of excelExporter ###
-
-The usage of the tool is explained in the usage text: Begin with running
-excelExporter with command line option --help.
-
-The command line interface of the application has the following concept:
-
-The arguments form groups. A group of successive arguments can specify an
-input file, another group can specify another input file or an output file
-and so on. The beginning of a group of arguments is recognized by a
-specific argument, the principal argument of the group. The usage text
-typically says "this argument opens the context of ...". Naturally, the
-same command line switches can be repeatedly used, once in each group of
-same kind.
-
-Such a group of command line arguments or a "context" actually is the
-representation of an object in the parameter tree of the application. This
-is the model behind the parameter tree:
-
-- Root elements are either Excel input file specifications, specifications
-  of generated output files or worksheet templates
-- The input file specification contains the Excel file name and it has any
-  number of worksheet selection objects as children
-    - A worksheet selection specifies one or more worksheets for parsing.
-      All sheets or any sub-set of sheets of a workbook can be parsed.
-      Selection can be made by name or by index
-- An output file specification contains the file name and information
-  about the StringTemplate V4 template to be applied
-- A worksheet template is a set of rules how to interpret one or more
-  worksheets. It can be applied to a particular worksheet or to several of
-  those, from either one or from several input files. It describes how the
-  data of a worksheet is organized in terms of groups and sub-groups. It
-  has any number of column attribute objects as children
-    - A column attributes object specifies properties of a column, like
-      name and sort order
-
-Besides the command line arguments from a group or context, there are
-"traditional" command line arguments, which relate to the run of the
-application as a whole, like logging and verbosity settings. The
-application usage text says they belong to the global context.
-
-Please note, different to the common GNU command line interface this
-application demands a blank between the switch and its value. For example
--oMyOutputFile.c would be rejected, whereas -o MyOutputFile.c would be the
-correct specification of a generated output file.
-
-The application's command line options relate to the definition of in- and
-output files and how to parse the input. To successfully use the
-application one still needs to understand the internal representation of
-the read input data (i.e. the data model) and the way it is rendered in
-the output files. The next sections explain the available, related
-documentation.
-
-
-### The data model ###
-
-The internal representation of the parsed input information is documented
-as a [Javadoc of the complete data structure](http://svn.code.sf.net/p/comframe/code/excelExporter/trunk/doc/dataModel/index.html?overview-summary.html "Javadoc of excelExporter's data model").
-
-Here, you find the documentation of all public elements of the data
-structure that are accessible from the StringTemplate V4 templates. The
-data structure is deeply nested, and actually, it are even two data
-structures, which are passed to the rendering process:
-
-- The parsed information forms an object of class Cluster
-- The information about output files plus some environmental information
-  is put into an object of class Info
-
-You will study the Javadoc pages to see, which pieces of information to be
-used from within a template.
-
-Please note, the Javadoc describes the different elements (classes) of the
-data model. Their nesting is not fully transparent from the Javadoc since
-recursive structures are involved. The actual structure of the data
-model will depend on (and reflect) the structure the input data is
-organized in. Only in the most simple case it's a linear list of so called
-[RowObjects](http://svn.code.sf.net/p/comframe/code/excelExporter/trunk/doc/dataModel/excelExporter/excelParser/dataModel/RowObject.html "Javadoc
-of class RowObject"), which represent a single row from the Excel input
-file and which consist of so called [CellObjects](http://svn.code.sf.net/p/comframe/code/excelExporter/trunk/doc/dataModel/excelExporter/excelParser/dataModel/CellObject.html "Javadoc
-of class CellObject"). In all other cases the actual data structure
-depends on your input data, on the format of your Excel file and on your
-application configuration (which all needs to be consistent with one
-another).
-
-Another source of this knowledge is the investigation of the sample
-templates: [excelExporter/samples/.../*.stg](https://svn.code.sf.net/p/comframe/code/excelExporter/trunk/samples/ "SVN root folder of samples").
-
-### The StringTemplate V4 templates ###
-
-The technique of rendering the information held in a Cluster and an Info
-object is well documented. The two objects are passed to the
-StringTemplate V4 template engine and this engine is fully documented.
-Please refer to <http: www.stringtemplate.org=""/> or find a printable version
-of the documentation as <https: svn.code.sf.net="" p="" comframe="" code="" excelExporter="" trunk="" doc="" ST4-270115-0836-52.pdf="">.
-
-Please note, as a matter of experience, you will have to read the
-StringTemplate V4 documentation entirely before you can start to
-successfully develop your first useful template. StringTemplate V4 is
-powerful and convenient but not self-explaining.
-
-Studying the samples [excelExporter/samples/.../*.stg](https://svn.code.sf.net/p/comframe/code/excelExporter/trunk/samples/ "SVN root folder of samples")
-is another important source of information.
-
-### The Wiki pages ###
-
-An additional source of documentation are the Wiki pages of the project,
-please refer to <https: sourceforge.net="" p="" excelexporter="" wiki="" browse_pages=""/>.
-The Wiki pages shade a light at some most relevant, selected issues; a
-comprehensive, self-contained (printable) manual is not planned. As of
-today, March 2016, we have the following discussions in the Wiki pages:
-
-- [Overview on the comFramework project](http://sourceforge.net/p/comframe/wiki/Home/
-  "comFramework - About this Project")
-
-
-## Installation ##
-
-excelExporter is a Java 7 application. The installation is as simple as
-unpacking an archive and optionally setting an environment variable. It is
-described in detail in the file
-[installation.txt](http://svn.code.sf.net/p/comframe/code/excelExporter/trunk/doc/installation.txt).
-
-
-## What's new ##
-
-### Release 0.16 ###
-
-The initial release. Full functionality of the application but preliminary
-state of samples and documentation.
-
 ## Download ##
 [[download_button]]

Home modified by Peter Vranken

Peter Vranken — Mon, 21 Mar 2016 21:03:25 -0000

--- v5
+++ v6
@@ -1,3 +1,5 @@
+[[include repo=comframe:code path=excelExporter/trunk/doc/readMe.md]]
+--------------------------------
 # excelExporter - Rendering Excel Spreadsheets as Text #

 ## Introduction ##

Home modified by Peter Vranken

Peter Vranken — Mon, 21 Mar 2016 20:42:42 -0000

--- v4
+++ v5
@@ -8,7 +8,7 @@
 general purpose text rendering application for Excel spreadsheets.

 excelExporter is the auxiliary code generator from the
-[comFramework](<https: sourceforge.net="" p="" comframe="" wiki="" Home=""/>
+[comFramework](http://sourceforge.net/p/comframe/wiki/Home/
 "Sourceforge repository of comFramework") project. However, the use of
 excelExporter is in no way restricted to the context of CAN interface
 generation in embedded, automotive software development. Because of its
@@ -102,7 +102,7 @@
 ### The data model ###

 The internal representation of the parsed input information is documented
-as a [Javadoc of the complete data structure](<http: svn.code.sf.net="" p="" comframe="" code="" excelExporter="" trunk="" doc="" dataModel="" index.html?overview-summary.html=""> "Javadoc of excelExporter's data model").
+as a [Javadoc of the complete data structure](http://svn.code.sf.net/p/comframe/code/excelExporter/trunk/doc/dataModel/index.html?overview-summary.html "Javadoc of excelExporter's data model").

 Here, you find the documentation of all public elements of the data
 structure that are accessible from the StringTemplate V4 templates. The
@@ -121,16 +121,16 @@
 recursive structures are involved. The actual structure of the data
 model will depend on (and reflect) the structure the input data is
 organized in. Only in the most simple case it's a linear list of so called
-[RowObjects](<https: svn.code.sf.net="" p="" comframe="" code="" excelExporter="" trunk="" doc="" dataModel="" excelExporter="" excelParser="" dataModel="" RowObject.html="">"Javadoc
+[RowObjects](http://svn.code.sf.net/p/comframe/code/excelExporter/trunk/doc/dataModel/excelExporter/excelParser/dataModel/RowObject.html "Javadoc
 of class RowObject"), which represent a single row from the Excel input
-file and which consist of so called [CellObjects](<https: svn.code.sf.net="" p="" comframe="" code="" excelExporter="" trunk="" doc="" dataModel="" excelExporter="" excelParser="" dataModel="" CellObject.html="">"Javadoc
+file and which consist of so called [CellObjects](http://svn.code.sf.net/p/comframe/code/excelExporter/trunk/doc/dataModel/excelExporter/excelParser/dataModel/CellObject.html "Javadoc
 of class CellObject"). In all other cases the actual data structure
 depends on your input data, on the format of your Excel file and on your
 application configuration (which all needs to be consistent with one
 another).

 Another source of this knowledge is the investigation of the sample
-templates: [excelExporter/samples/.../*.stg](<https: svn.code.sf.net="" p="" comframe="" code="" excelExporter="" trunk="" samples=""/> "SVN root folder of samples").
+templates: [excelExporter/samples/.../*.stg](https://svn.code.sf.net/p/comframe/code/excelExporter/trunk/samples/ "SVN root folder of samples").

 ### The StringTemplate V4 templates ###

@@ -145,7 +145,7 @@
 successfully develop your first useful template. StringTemplate V4 is
 powerful and convenient but not self-explaining.

-Studying the samples [excelExporter/samples/.../*.stg](<https: svn.code.sf.net="" p="" comframe="" code="" excelExporter="" trunk="" samples=""/> "SVN root folder of samples")
+Studying the samples [excelExporter/samples/.../*.stg](https://svn.code.sf.net/p/comframe/code/excelExporter/trunk/samples/ "SVN root folder of samples")
 is another important source of information.

 ### The Wiki pages ###
@@ -176,4 +176,5 @@
 state of samples and documentation.

 ## Download ##
-[[download_button]]
+[[download_button]]  
+

Home modified by Peter Vranken

Peter Vranken — Mon, 21 Mar 2016 20:40:36 -0000

--- v3
+++ v4
@@ -121,9 +121,9 @@
 recursive structures are involved. The actual structure of the data
 model will depend on (and reflect) the structure the input data is
 organized in. Only in the most simple case it's a linear list of so called
-[RowObjects](http://svn.code.sf.net/p/comframe/code/excelExporter/trunk/doc/dataModel/excelExporter/excelParser/dataModel/RowObject.html "Javadoc
+[RowObjects](<https: svn.code.sf.net="" p="" comframe="" code="" excelExporter="" trunk="" doc="" dataModel="" excelExporter="" excelParser="" dataModel="" RowObject.html="">"Javadoc
 of class RowObject"), which represent a single row from the Excel input
-file and which consist of so called [CellObjects](https://svn.code.sf.net/p/comframe/code/excelExporter/trunk/doc/dataModel/excelExporter/excelParser/dataModel/CellObject.html"Javadoc
+file and which consist of so called [CellObjects](<https: svn.code.sf.net="" p="" comframe="" code="" excelExporter="" trunk="" doc="" dataModel="" excelExporter="" excelParser="" dataModel="" CellObject.html="">"Javadoc
 of class CellObject"). In all other cases the actual data structure
 depends on your input data, on the format of your Excel file and on your
 application configuration (which all needs to be consistent with one

Home modified by Peter Vranken

Peter Vranken — Mon, 21 Mar 2016 20:36:25 -0000

--- v2
+++ v3
@@ -121,9 +121,9 @@
 recursive structures are involved. The actual structure of the data
 model will depend on (and reflect) the structure the input data is
 organized in. Only in the most simple case it's a linear list of so called
-[RowObjects](<https: svn.code.sf.net="" p="" comframe="" code="" excelExporter="" trunk="" doc="" dataModel="" excelExporter="" excelParser="" dataModel="" RowObject.html="">"Javadoc
+[RowObjects](http://svn.code.sf.net/p/comframe/code/excelExporter/trunk/doc/dataModel/excelExporter/excelParser/dataModel/RowObject.html "Javadoc
 of class RowObject"), which represent a single row from the Excel input
-file and which consist of so called [CellObjects](<https: svn.code.sf.net="" p="" comframe="" code="" excelExporter="" trunk="" doc="" dataModel="" excelExporter="" excelParser="" dataModel="" CellObject.html="">"Javadoc
+file and which consist of so called [CellObjects](https://svn.code.sf.net/p/comframe/code/excelExporter/trunk/doc/dataModel/excelExporter/excelParser/dataModel/CellObject.html"Javadoc
 of class CellObject"). In all other cases the actual data structure
 depends on your input data, on the format of your Excel file and on your
 application configuration (which all needs to be consistent with one

Home modified by Peter Vranken

Peter Vranken — Mon, 21 Mar 2016 20:33:37 -0000

--- v1
+++ v2
@@ -1,8 +1,179 @@
-Welcome to your wiki!
+# excelExporter - Rendering Excel Spreadsheets as Text #

-This is the default page, edit it as you see fit. To add a new page simply reference it within brackets, e.g.: [SamplePage].
+## Introduction ##

-The wiki uses [Markdown](/p/excelexporter/wiki/markdown_syntax/) syntax.
+This archive contains the binary distribution of excelExporter, an
+application that can translate the information found in one or more Excel
+workbooks into manyfold textual representations. excelExporter is a
+general purpose text rendering application for Excel spreadsheets.

-[[members limit=20]]
+excelExporter is the auxiliary code generator from the
+[comFramework](<https: sourceforge.net="" p="" comframe="" wiki="" Home=""/>
+"Sourceforge repository of comFramework") project. However, the use of
+excelExporter is in no way restricted to the context of CAN interface
+generation in embedded, automotive software development. Because of its
+generality we decided to publish it as independent Sourceforge project.
+This relates to the binaries and the documentation. The source code and
+the build scripts remain part of project comFramework; some of the links
+down here will thus point to that other project.
+
+The principal aim of the tool is supporting automation tasks in software
+development environments. In the context of the comFamework project this
+targets the handling of data dictionaries and interfaces but excelExporter
+is by design independent from this intented purpose and will be useful for
+various other automation tasks.
+
+You can render the information in the Excel input for example as:
+
+- HTML or LaTeX for documentation
+- Various XML formats for interfacing with other applications
+- C/C++ or any other textual programming languages
+
+In- and output description are decoupled in the parametrization of the
+tool. First you will specify a set of Excel input files. All of these are
+parsed and merged to one large data structure, ofter refered to as _data
+model_. Input files of same or of different format are supported.
+("Format" refers to the structure of the Excel files with respect to
+contained sheets and columns.)
+
+Secondary, you will define a list of output files. The specification of
+each output file is associated with the specification of a StringTemplate
+V4 template file. The template controls the output generation and this is
+how the same information is rendered once as HTML code and once as - for
+example - C program fragment.
+
+
+## Documentation ##
+
+### Command line interface of excelExporter ###
+
+The usage of the tool is explained in the usage text: Begin with running
+excelExporter with command line option --help.
+
+The command line interface of the application has the following concept:
+
+The arguments form groups. A group of successive arguments can specify an
+input file, another group can specify another input file or an output file
+and so on. The beginning of a group of arguments is recognized by a
+specific argument, the principal argument of the group. The usage text
+typically says "this argument opens the context of ...". Naturally, the
+same command line switches can be repeatedly used, once in each group of
+same kind.
+
+Such a group of command line arguments or a "context" actually is the
+representation of an object in the parameter tree of the application. This
+is the model behind the parameter tree:
+
+- Root elements are either Excel input file specifications, specifications
+  of generated output files or worksheet templates
+- The input file specification contains the Excel file name and it has any
+  number of worksheet selection objects as children
+    - A worksheet selection specifies one or more worksheets for parsing.
+      All sheets or any sub-set of sheets of a workbook can be parsed.
+      Selection can be made by name or by index
+- An output file specification contains the file name and information
+  about the StringTemplate V4 template to be applied
+- A worksheet template is a set of rules how to interpret one or more
+  worksheets. It can be applied to a particular worksheet or to several of
+  those, from either one or from several input files. It describes how the
+  data of a worksheet is organized in terms of groups and sub-groups. It
+  has any number of column attribute objects as children
+    - A column attributes object specifies properties of a column, like
+      name and sort order
+
+Besides the command line arguments from a group or context, there are
+"traditional" command line arguments, which relate to the run of the
+application as a whole, like logging and verbosity settings. The
+application usage text says they belong to the global context.
+
+Please note, different to the common GNU command line interface this
+application demands a blank between the switch and its value. For example
+-oMyOutputFile.c would be rejected, whereas -o MyOutputFile.c would be the
+correct specification of a generated output file.
+
+The application's command line options relate to the definition of in- and
+output files and how to parse the input. To successfully use the
+application one still needs to understand the internal representation of
+the read input data (i.e. the data model) and the way it is rendered in
+the output files. The next sections explain the available, related
+documentation.
+
+
+### The data model ###
+
+The internal representation of the parsed input information is documented
+as a [Javadoc of the complete data structure](<http: svn.code.sf.net="" p="" comframe="" code="" excelExporter="" trunk="" doc="" dataModel="" index.html?overview-summary.html=""> "Javadoc of excelExporter's data model").
+
+Here, you find the documentation of all public elements of the data
+structure that are accessible from the StringTemplate V4 templates. The
+data structure is deeply nested, and actually, it are even two data
+structures, which are passed to the rendering process:
+
+- The parsed information forms an object of class Cluster
+- The information about output files plus some environmental information
+  is put into an object of class Info
+
+You will study the Javadoc pages to see, which pieces of information to be
+used from within a template.
+
+Please note, the Javadoc describes the different elements (classes) of the
+data model. Their nesting is not fully transparent from the Javadoc since
+recursive structures are involved. The actual structure of the data
+model will depend on (and reflect) the structure the input data is
+organized in. Only in the most simple case it's a linear list of so called
+[RowObjects](<https: svn.code.sf.net="" p="" comframe="" code="" excelExporter="" trunk="" doc="" dataModel="" excelExporter="" excelParser="" dataModel="" RowObject.html="">"Javadoc
+of class RowObject"), which represent a single row from the Excel input
+file and which consist of so called [CellObjects](<https: svn.code.sf.net="" p="" comframe="" code="" excelExporter="" trunk="" doc="" dataModel="" excelExporter="" excelParser="" dataModel="" CellObject.html="">"Javadoc
+of class CellObject"). In all other cases the actual data structure
+depends on your input data, on the format of your Excel file and on your
+application configuration (which all needs to be consistent with one
+another).
+
+Another source of this knowledge is the investigation of the sample
+templates: [excelExporter/samples/.../*.stg](<https: svn.code.sf.net="" p="" comframe="" code="" excelExporter="" trunk="" samples=""/> "SVN root folder of samples").
+
+### The StringTemplate V4 templates ###
+
+The technique of rendering the information held in a Cluster and an Info
+object is well documented. The two objects are passed to the
+StringTemplate V4 template engine and this engine is fully documented.
+Please refer to <http: www.stringtemplate.org=""/> or find a printable version
+of the documentation as <https: svn.code.sf.net="" p="" comframe="" code="" excelExporter="" trunk="" doc="" ST4-270115-0836-52.pdf="">.
+
+Please note, as a matter of experience, you will have to read the
+StringTemplate V4 documentation entirely before you can start to
+successfully develop your first useful template. StringTemplate V4 is
+powerful and convenient but not self-explaining.
+
+Studying the samples [excelExporter/samples/.../*.stg](<https: svn.code.sf.net="" p="" comframe="" code="" excelExporter="" trunk="" samples=""/> "SVN root folder of samples")
+is another important source of information.
+
+### The Wiki pages ###
+
+An additional source of documentation are the Wiki pages of the project,
+please refer to <https: sourceforge.net="" p="" excelexporter="" wiki="" browse_pages=""/>.
+The Wiki pages shade a light at some most relevant, selected issues; a
+comprehensive, self-contained (printable) manual is not planned. As of
+today, March 2016, we have the following discussions in the Wiki pages:
+
+- [Overview on the comFramework project](http://sourceforge.net/p/comframe/wiki/Home/
+  "comFramework - About this Project")
+
+
+## Installation ##
+
+excelExporter is a Java 7 application. The installation is as simple as
+unpacking an archive and optionally setting an environment variable. It is
+described in detail in the file
+[installation.txt](http://svn.code.sf.net/p/comframe/code/excelExporter/trunk/doc/installation.txt).
+
+
+## What's new ##
+
+### Release 0.16 ###
+
+The initial release. Full functionality of the application but preliminary
+state of samples and documentation.
+
+## Download ##
 [[download_button]]

Home modified by Peter Vranken

Peter Vranken — Sat, 09 Jan 2016 14:43:12 -0000

Welcome to your wiki!

This is the default page, edit it as you see fit. To add a new page simply reference it within brackets, e.g.: [SamplePage].

The wiki uses Markdown syntax.

Project Members:

Peter Vranken (admin)