| Publish Format |
Defines Microsoft Word publish formatting properties.
This is based solely on Word, before any other conversion occurs.
| Property | Description | | Publish Options |
Offers options for exported files.
| Property | Description | | Publish Filename | Filename for the published file.
Two default options are provided: [worksheetid] and [worksheetname].
This property is editable and supports many substitution
options, including [currentuser], [authorid], [author], [authorname],
[title], [worksheetname], [worksheetdesc], [worksheetid],
[worksheetversionid], [worksheetstatus], [workbookid], [workbookdesc],
[workbookname], [workbookownerid], [workbookowner], [workbookownername],
[shortdate], [mediumdate], [longdate], [shortdatetime], [mediumdatetime],
[longdatetime], [date], [datetime], [currentdate], and [currentdatetime]. | | Based on Word Template | Word template to be used as the
basis for the exported document, e.g., [applicationhome]/officetemplates/ELN2.dotx.
Two example templates (ELN1.dotx and ELN2.dotx) are available
OOB in the LABVANTAGE_HOME\APPLICATION_HOME\officetemplates
directory. Projects can add their own additional templates
in this folder if desired. Word Templates can include tokens whose values will be substituted
from the Worksheet at publish time. These token can be used
in both the title page and in headers and footers. For example,
the following header in the Word Template: Looks like this at publish time: The following tokens are available for use (tokens in parentheses
are synonyms): [currentuser], [authorid], ( [author], [authorname]
), ( [title], [worksheetname], [worksheetdesc] ), [worksheetid],
[worksheetversionid], [worksheetstatus], [workbookid], ( [workbookdesc],
[workbookname] ), [workbookownerid], ( [workbookowner], [workbookownername]
), [shortdate], ( [date], [mediumdate], [currentdate] ), [longdate],
[shortdatetime], ( [datetime], [mediumdatetime], [currentdatetime]
), and [longdatetime]. Using a Word template has the following affect on other Publish
options: | • | "Text Style" properties are ignored. All
styling information should be defined within the template. | | • | The "Include Title Page" option is still honored.
If set to "Yes", the publish routine will generate
a title page. However, it is recommended that the title
page is included in the Word template itself, as this
allows for more visually pleasing documents. | | • | The "Include Table of Contents" option is
still honored. If set to "Yes", a Table of Contents
page will be automatically generated. | | • | Header and Footer properties are ignored when using
a Word template. These are expected to be defined in the
template itself. |
| |
Allow MS Word
Allow PDF Allow HTML | These properties are provided
to restrict exports to specified file formats. When set to "Yes",
the publish file format is shown when clicking the "Publish"
button on the Worksheet
Manager Toolbar, and allows the format to be exported using
the ExportWorksheet
Action. Setting the relevant property to "No"
prevents the format from being shown by the Publish button, and
prevents the format from being published by the Action. |
| | PageSetup | Defines page formatting
in the exported document.
| Property | Description | | Page Size | Determines the printed page size.
Options are Letter, Legal, A4, A5, B5, Custom. Alternatively,
you can also specify custom page width and height below. | | Custom PageWidth | Custom page width. The units can
be any supported by Word. | | Custom Height | Custom page height in the same
units as page width. | | Orientation | Determines the printed page orientation.
Options are Portrait and Landscape. | | Margin Style | Options are Normal, Narrow, Moderate,
Wide (as defined by Word). Alternatively, you can also specify
custom margins below. | | Custom Margin Top | Custom top margin (if desired)
in the same units as page width. | | Custom Margin Bottom | Custom bottom margin (if desired)
in the same units as page width. | | Custom Margin Left | Custom left margin (if desired)
in the same units as page width. | | Custom Margin Right | Custom right margin (if desired)
in the same units as page width. |
| | Text Styles | Defines text formatting
in the exported document.
| Property | Description | | Style
Name | Microsoft Office style defined
for the docx format. Options are Normal, Heading 1, Heading
2, Heading 3, Heading 4, Header Footer, Caption, Main Title.
You can also create your own additional styles by adding
Reference Values to the ELNExportTextStyles Reference Type. | | Font Name | Windows TTF to use in the document. | | Font Size | Font size for the style in units
supported by the corresponding Word style. | | Text Color | Color of the text. | | Bold | Applies bold text formatting. | | Italics | Applies italic text formatting. | | Underline | Applies underline text formatting. |
| | Title Page | Defines the format of the
Title Page in the published document.
| Property | Description | | Include Title Page | Determines if the document contains
a title page. If "Yes", the options below determine
formatting. | | Top Text | Text shown at the top of the Title
Page. | | MiddleText | Text shown at the middle of the
Title Page. | | Bottom Text | Text shown at the bottom of the
Title Page. | | Top Text Style | Office style applied to the Top
Text. Choices are the same as Publish Format → Text Styles → Style Name. | | Middle Text Style | Office style applied to the Middle
Text. Choices are the same as Publish Format → Text Styles → Style Name. | | Bottom Text Style | Office style applied to the Bottom
Text. Choices are the same as Publish Format → Text Styles → Style Name. | | paddingbottom | Padding applied to the bottom of
the page. | | paddingtop | Padding applied to the top of the
page. |
| | Table of Contents | Defines the format of the
Table of Contents in the exported document.
| Property | Description | | Include Table of Contents | Determines if a Table of Contents
is generated. If "Yes", the options below determine
formatting. | | ToC Title | Title of the Table of Contents. | | ToC Title Text Style | Office style applied to the ToC
style. Choices are the same as
Publish Format → Text Styles → Style Name. |
| | Headers and Footers | Defines the format of Headers
and Footers in the exported document.
| Property | Description | | Show Header | Determines if Headers are shown.
If "Yes", the options below determine formatting. | | Header Left Text | Left-justified Header text. | | Header Middle Text | Centered Header text. | | Header Right Text | Right-justified Header text. | | Header Text Style | Office style applied to the Header
Text. Choices are the same as Publish Format → Text Styles → Style Name. | | Show Footer | Determines if Footers are shown.
If "Yes", the options below determine formatting. | | Footer Left Text | Left-justified Footer text. | | Footer Middle Text | Centered Footer text. | | Footer Right Text | Right-justified Footer text. | | Footer Text Style | Office style applied to the Footer
Text. Choices are the same as Publish Format → Text Styles → Style Name. |
| | Sections | Defines Section formatting in the exported
document.
| | PDF Options | Defines options compatible
with the specified Adobe Acrobat PDF compliance standard.
| Property | Description | | Add Bookmarks | Determines if PDF Bookmarks are
shown. | | Bookmark Mode | Determines the PDF elements for
which Bookmarks are created. Choices are Level 1 Sections, All
Sections, All Sections, and Captions. | | PDF Standard | Adobe Acrobat PDF format compliance
standard. Choices are PDF 1.5, PDF/A-1a, and PDF/A-1b. See http://www.pdfa.org/2011/06/pdfa-faq. |
| | Notes and Comments | Determines which Notes
are shown.
| Property | Description | | Show Notes | "Yes" shows
only the top-level Notes. | | Show Additional Comments | "Yes" shows
the levels below the top-level Notes (such as Comments). |
| | Images | Determines image behavior
in the export.
| Property | Description | | Show Image Markup | Determines if image
markups are shown. |
| | Metadata | Determines metadata behavior
in the markup.
| Property | Description | | Show Metadata | Determines if metadata
are shown. | | Caption Title | If metadata are shown,
this is the relevant Caption Title. |
|
|
| ChemAxon Settings |
Determines how the ChemAxon Marvin
Editor Control is licensed and deployed.
| Property | Description | | Marvin License Type | Configures the mode in
which the Marvin Editor Control is used.
| Mode | Description | | None (Evaluation
Only) | The Marvin Editor
Control operates without a ChemAxon license or ChemAxon Web
Services in an "evaluation" mode. The Control indicates
that it cannot find a ChemAxon license by displaying "Valid
license cannot be found" in the upper left corner of the
editor.
This is the mode preselected in the OOB configuration. | | MarvinJS Only | The Marvin Editor
Control operates in a "basic" mode without the additional
capabilities provided by Chem Axon Web Services (such as extended
file types, image rotation, etc.).
In this mode, the "Marvin License File" property
(below) is made available to specify the location and name
of your license file if it differs from the default provided
in the OOB configuration. | | MarvinJS + WebServices | The Marvin Editor
Control attempts to connect to ChemAxon Web Services to gain
extended functionality. In this mode, ChemAxon Web Services
(webservices.war) must be deployed in the Application Server.
The Application Server must be running in a JDK 8 environment.
The ChemAxon Web Services will not deploy in an environment
lower than JDK 8.
For users with ChemAxon licenses, detailed instructions regarding
Web Service deployment are available at www.chemaxon.com.
At the time this document was written, only sections 1 and
2 of these instructions were applicable ("Prerequisites"
and "Deploying Web Application"), as the database,
authentication, and reagent libraries are not currently used. The ChemAxon webservices.war file is provided in the LabVantage
distribution. When using these Web Services, the two license
files (one for MarvinJS, one for the Web Services) must be
placed in a specific folder as described in the ChemAxon installation
instructions (such as in %UserProfile%\chemaxon\licenses on
a Windows OS platform). Current testing indicates that the
Web Service license file can be given any name, but the MarvinJS
license file must be named "licenseMarvinJS.cxl". The "WebServices Server Name" and "WebServices
Web App" properties (below) are made available to specify
the name of the host machine and Web Application if they differ
from the default provided in the OOB configuration. |
| | Marvin License File | The default value provided
in the OOB configuration is LABVANTAGE_HOME/APPLICATION_HOME/chemaxon/licenseMarvinJS.cxl.
In "MarvinJS Only" mode, you can change both the location
and name of the license. If you do this, change this property to point
to different location and filename. | | WebServices Server Name | In the OOB configuration,
this is left blank. A blank value defaults to the hostname of the
machine hosting the Application Server. | | WebServices Web App | The default is webservices. |
|
