You are on page 1of 45

LinkOne Version 4.1.

3
Release Notes
19 September 2001

Welcome to LinkOne Version 4.1.3. This is the fourth major functionality update of the
LinkOne system, and represents a major change in the architecture and capabilities of the
software.
For The Latest Changes
For details on any minor changes or fault corrected in this release of LinkOne Version 4.1, or in
previous releases, please refer to the Release Notes book in the LinkOne Manuals folder in
your LinkOne library. Simply open the LinkOne Viewer. If the Browse Books dialog does not
appear automatically, click File, then Open Book, then Browse... In the Browse Books dialog,
scroll down to "LinkOne Manuals", click on the [+] and then on "Release Notes for Version 4",
then click Open.

Installation
Prerequisites

In order to install LinkOne 4.1, you must have Windows 95 OSR2 or later, and
have Internet Explorer 5.5 or later installed. You cannot install LinkOne 4.1
on a bare-bones Windows 95 system.

There are two primary components in LinkOne version 4.1 You can choose to just install the
Viewer component, or to install both the Viewer and the Publisher. Each component requires a
serial number to activate it, although the Viewer will operate in ‘demonstration mode’ if it is
installed without a serial number.

Installing the Viewer

To install the Viewer, you should run the INSTALL.EXE program in the Viewer Kit.

• If you have a LinkOne CD-ROM, then open or explore the CD-ROM drive, open the
Viewer Kit folder, then double-click on the INSTALL.EXE icon.

• If you downloaded a Viewer Kit from the Internet, then double-click the Viewer Kit.exe file
to expand it, then double-click on the INSTALL.EXE in the expanded files.

The LinkOne Install program will display a series of screens. Fill in any appropriate details on
the screens and then click the Next> button. On the last screen, click Finish and the installation
will then occur.

By default, the Viewer will install to C:\Program Files\LinkOne, and it is recommended that you
use this default.
The installation procedure will automatically create a “Manuals” library and install the LinkOne
online manuals in that library.

Installing the Publisher

The simplest way to install the Publisher is to the INSTALL.EXE program in the Publisher Kit.

• If you have a LinkOne CD-ROM, then open or explore the CD-ROM drive, open the
Publisher Kit folder, then double-click on the INSTALL.EXE icon.

• If you downloaded a Publisher Kit from the Internet, then double-click the Publisher Kit.exe
file to expand it, then double-click on the INSTALL.EXE icon in the expanded files.

By default, the Publisher will install to the folder you installed the Viewer to, and it is
recommended that you use this default.

Differences from Version 3

Note that you no longer specify the “BIN” directory in the install location. LinkOne will
automatically create appropriate subdirectories under the location you specify.

Version 4 utilises new serial numbers. Version 3.1 serial numbers will not be useable. The
version 4 serial numbers are kept separate to the version 3.1 serial numbers, so you can have
both types installed at the same time. If you have Security Keys or Book Keys from Version
3.1, you can still use them with Version 4.1.

Note: From Version 4.1, publishers need new license codes. These codes are linked to
the machine from which you are publishing. To obtain the new code you must supply
the machine id (found in Administration/Licensing) along with your company details in
an email to Linkone -admin@mincom.com.

32-bit Compatibility in the DBMAN module

For the convenience of users who still utilise the old DBMAN configuration server, we provide
a copy of that module with version 4. The DBMAN module supplied with LinkOne version 4 is
still a 16-bit application, and as such it is unable to handle long file names. If you install the
DBMAN module, you must either ensure that its database folder is stored in a location that uses
only short (8-character) names, or that you specify the short-filename equivalent for its database
location when you install it.
New Features of Version 4.1
Changes from Version 4.0
The key changes from version 4.0 are

1. Inclusion of Leadtools Filters


2. Native JPEG support within Books
3. New Licensing requirements for publishing.
4. Changes to Draft Mode operation
Each of these is explored below.
Leadtools Filters
New graphic filters have been included with this release of Linkone. They provide the ability to
import a wide range of raster image formats and allow rasterising of vector images. In future
releases, we will include the vector to vector import facility.
A new Administration function is now available which allows the user to specify which filters
(LeadTools, ImageStream or Builtin) to use for particular file types.

This dialog allows you to set the order in which Linkone will attempt to use filters to import a file
type. If the first filter selected fails then the next filter in the list will be tried. Thus, if for
whatever reason in the above example, the Builtin Loader fails to load the PCX file, then
Linkone will step through to the Imagestream Filter and finally the Leadtools filter in attempting
to import the file.

Note that the order setting for JPG images is separate from the above order and is driven solely
by the quality setting.
Native JPEG Support within Books

The ability to build a book containing raster images as JPEG instead of BMP has been
included. This will produce a 4.1 type book (see book builder dialog below) if used as only 4.1
readers will understand the image format. The benefit of course if that small JPEG images stay
small in the resulting ILG files. This makes for speedier downloads when using internet
delivered books in particular. Previously, JPEGS were actually converted to WMF format and
placed uncompressed in the raster section of the metafile. This resulted in an uncompressed
image blowing out to 10 times or more the size of the original JPEG.

Book Builder Dialog showing 4.1 build option


If you choose to build for an earlier version then JPEG images will be converted to BMP format
and the large increase in size will occur as in the past.

Hotpoint now includes a "Quality" entry field (see below) that allows you to specify a value
between 0 and 100 for the quality of the image. Values of 0, 100 or blank will mean that there
will be lossless compression - BMP format. A value between 1 and 99 will enable the JPEG
compression, with 1 representing the most compression loss (smallest file) and 99 the least
compression loss (larger file). Users wishing to keep roughly their existing JPEG size should use
99 as a value here.
Hotpoint Dialog showing Quality Entry field for JPEG images.
In addition there is a change to the Book Information Editor (see below) that allows you to
specify a default quality setting for the entire book.
If the quality is set for an individual file within Hotpoint, this will take precedence over the global
setting.

Book Information Editor Dialog showing Default Graphics Quality


Entry field for JPEG images.
Licensing System Changes
Publishing System licenses are now tied to a particular machine. This means that it will no
longer be possible to copy a key from one machine to another without contacting Innotech.

The procedure for obtaining the new license key is as follows.


1. Install the Publishing System.
2. Run "Administration". The Machine Key is displayed under the licensing section.

3. Email/Fax/Phone this key to Innotech 'linkone.info@mincom.com' with a subject of


'Publisher License' and containing the Company name and contact details for the reply.
4. Innotech will return to the publisher the key activating their publishing license for that
machine.
Draft Mode Changes
Books published in Draft Mode when viewed on Systems that DO NOT HAVE A
PUBLISHER LICENSE will now get the warning regarding the book being draft on every
page. This requires an OK click on every page to dismiss the dialog. If a viewer views the
book with a valid publisher license installed then the book only displays the warning upon
opening the book. This is to ensure that draft books are used for their intended purpose of
review and not for release.
The key new features of LinkOne Version 4.x are:

Terminology Changes from Version 3.x


As part of the changes in Version 4, we have changed some of the terminology that we used in
previous versions:
Annotations are now referred to as Notes.
Book Locations are now referred to as Libraries .
The Setup program is now referred to as LinkOne Administration .
Viewer Features
The Viewer incorporates the following new features from version 3.x:

1 Fully 32-bit, written in C++ and utilising object-oriented concepts and COM.

2 Plug-In document handler architecture.


• Plug-In handlers for PDF, SGML, HTML and XML
• The PDF plug-in uses the Adobe Acrobat free viewer available from
http://www.acrobat.com . *** Note that Linkone does not yet support Adobe
version 5.0. Please ensure you install the 4.0 reader.
• The HTML plug-in utilises Microsoft IE5 technology, and can handle frames,
scripting, animated GIFs and browser plug-ins such as PDF, Microsoft Office
documents and Shockwave.
• The HTML plug-in also handles XML display.
• The SGML plug-in incorporates Synex Viewport technology, and supports
Synex’s style sheet implementation for formatting SGML for display.

3 Captive Web Sites.


• HTML documents can contain links to live web sites - URL addresses.
• Pages can be assigned a URL, which will open that web site when the page is
opened.
• Pages can be given URL Filters, which will prevent access to any addresses not
listed in the filters.
• You can use an authenticating proxy server to prevent users from accessing the
internet using normal browsers, but configure LinkOne with a username and
password, so that users can access captive web sites only through the
controlled LinkOne environment. Users cannot see the username and
password, which are stored in encrypted form.

4 LinkOne-Enabled HTML.
• HTML documents and Captive Web Sites can contain selectable parts entries.
These will have 'tick boxes' and can be added to your selection list like any
other part entry.
• The special markup for LinkOne-Enabled HTML is invisible to standard
browsers, and can be added to normal web sites. Only when viewed with
LinkOne will the selectable parts information be available.

5 New-Look Interface
• You can completely customise the menus and toolbars.
• Toolbar buttons all include tooltips. Tooltips can be translated to other
languages.
• You can control when toolbars will be visible: You can make them hide when
all their controls are disabled, or you can have them only appear on pages that
use a particular template.
• Toolbars can be docked or floating. You can dock toolbars in any of eight
possible ‘docking sites’.
• You can disable customisation of the interface, and you can disable the ‘tear
off’ and ‘dock’ behaviour of toolbars.
• The Selection List and table of contents can also be floating or docked, like a
toolbar.

6 Remote Libraries
• The ability to define a Remote Library - making all of the books at a web site
available without having to individually install them.

7 Online Manuals
• The Viewer User Guide, Viewer Reference Manual, and LinkOne
Administration Manual are all now supplied as LinkOne books.

8 Enhanced Internet Access


• The Viewer now supports access through authenticating proxy servers, and
supports secure protocols such as HTTPS using SSL and PCT. It also
supports HTTP version 1.1

Book Builder Features


The Book Builder incorporates the following new features from 3.x:

1 Fully 32-bit, written in C++ and incorporating object-oriented concepts and COM.

2 Plug-in document handler architecture.


• Plug-In handlers for PDF, SGML and HTML
• Ability to handle other arbitrary embedded data (eg. XML, PDF, Word)

3 Full long-filename support


• LDF files and graphics files can be given names of any length.
• The length limits for page numbers and page reference codes have not changed.
• The suffixing system for implicit relationship of pictures and lists still works.
• The suffixing system has been extended to allow any number of pictures per
page, and any number of overlays per picture.
4 Version 3.1 source-books are fully compatible with the version 4 book builder.
• Purely parts-only version 4 books which use only short (3.1-compatible) file
names will still be readable by version 3.1 viewers.
• Books that include ‘GTi’ data, or which use long file names or other version 4
features, will only be readable by version 4 Viewers.

5 Version 4 Book Builder simplifies the publishing process. The Book Builder
automatically creates CD-ready or Internet-ready target books. It can also handle
incremental builds of single-file books.

4 Enhanced security control for derived books.

Hotpoint Features
Hotpoint incorporates the following new features from 3.x:

1 Fully 32-bit, written in C++ and incorporating object-oriented concepts and COM.

2 Plug-in document handler architecture.


• Plug-In handlers for PDF, SGML and HTML
• The Document tab on the List Details dialog displays a custom-editing interface
for each plug-in handler.

3 Full long-filename support


• LDF files and graphics files can be given names of any length.
• The length limits for page numbers and page reference codes have not changed.
• The suffixing system for implicit relationship of pictures and lists still works.
• The suffixing system has been extended to allow any number of pictures per
page, and any number of overlays per picture.

LinkOne Administration Features


The version 3.x LinkOne Setup program and the Book Manager have been replaced by a
single LinkOne Administration utility.

The LinkOne Administration utility incorporates all of the functionality of the previous Setup
program, and in addition incorporates the following:
1 Drag-and drop installation for books and software.

2 Compress books into single-file books, or expand them to multi-file books. (right-click
on the books in the Book tab)

3 Prepare target books for web delivery. (right-click on the books in the Book tab).

4 Configure LinkOne with an encrypted proxy-server username and password, so that


users can only access the internet through LinkOne captive web sites. You can give
LinkOne the plain-text username and password (LinkOne stores it in encrypted form),
or you can give it the already-encrypted username and password. This enables system
administrators to authorise people by phone, fax or email, without giving away the
authorising username and password.

Installation Features
1 The Installation program has been updated to a “Wizard” style look and feel.

2 The ‘Shared LAN Installation’ process has been altered, to make it simpler for system
administrators. With Version 4.1, your LinkOne Bin folder will contain a copy of
Install.exe and an Auto.cnt file. Users wishing to share a copy of LinkOne across a
LAN simply go to the shared LinkOne Bin folder and run Install . System
administrators can alter the Auto.cnt file to create a custom installation, and can pre-
configure the LinkOne user interface and other settings.

3 Pre-configuration is done by the administrator configuring their LinkOne installation,


then using LinkOne Administration to save their settings as ‘Default’. Users doing a
‘Shared LAN’ installation will be given the saved defaults as their initial settings.

4 For people who produce rebadged versions of LinkOne, the installation procedure can
be used to assign custom icons to any of the LinkOne programs.

5 In addition, for people rebadging or creating translations into local languages, the
various graphic ‘splash’ pages displayed in Viewer, Install and LinkOne
Administration can all be replaced with customised versions, simply by placing a
suitably-named BMP file in the folder with the program in question:
Viewer:
OpeningSplashPage.bmp
Install.exe:
InstallSplash.bmp
LinkOne Administration; “General” tab:
SetupSplash.bmp
LinkOne Administration; Installing books from floppy disks:
BookInstallSplash.bmp
LinkOne Administration; Installing software:
SoftwareInstallSplash.bmp

There is also a default InstallSplash.bmp file created in the LinkOne Bin folder when
you install the Viewer. This file is displayed by Install when anybody does a ‘Shared
LAN installation’ from that copy of LinkOne.

New Features Reference


The following sections explain both the key new features and the other minor enhancements in
more detail.

Viewer Customisable Interface


The Viewer has a new-look user interface. In addition, the new interface is highly customisable.
You can add and remove menus and buttons, move them around, and add, delete and
reposition toolbars. You can change the icons for any of the buttons, and easily add new icons.

All buttons and toolbars also have a right-click menu that can be used to control their behavior.
In particular the Table of Contents and the Selection List both include right-click menus to
manipulate them.

Customising and using the new interface is described in detail in the on-line Viewer User Guide.
Some features that may not be immediately obvious are:

• The over-all arrangement of your interface is referred to as a scheme.


• You can dock any floating toolbar by double-clicking on its caption.
• You can customise the interface at any time by holding down the ALT key and dragging
buttons around.
• The Scheme tab in the Customise dialog can be used to set the attributes of your commands
and toolbars - even if they are currently hidden on the interface.
• Your saved schemes are stored in the schemes folder under LinkOne Bin. Your currently
active scheme is defined in the LinkOne_UI.ini file in your Windows folder.
• In the list of commands in the Commands card in the Customise dialog, you can right-click
to change the way the list is displayed.
• When dragging a toolbar to a docking location, a grey line will indicate where the toolbar
intends to dock. You can dock a toolbar above or below any existing toolbar, or beside an
existing toolbar, or on any of the edges of the LinkOne window. You can dock across the
whole width of the window, or just above or below the picture or the parts list.
• When you drag near a corner, toolbars will tend to dock on the top or bottom rather than
the side. You can force them to favour the sides instead by holding down the SHIFT key.
• You can stop a toolbar from docking by holding down the CONTROL key. You can also
turn off the ‘docking’ behaviour for any toolbar.
• There is a special control called a ‘gap’, which you can use to separate controls on a
toolbar, or make the controls right-justified.

Plug-In Document Handlers


The Book Builder and Viewer both support the concept of a plug-in document handler. Each
page of a Version 4 LinkOne book can contain a collection of embedded files. The page will
also be assigned a data type. The data type identifies which plug-in document handler is to
deal with the embedded files.
Records in the LDF file for the page specify the data type and the embedded files. The Book
Builder plug-in handlers can also identify some embedded files automatically.

At present the Hotpoint program is not ready, so you have to add the necessary records in the
List Definition Files by hand.

Data Types

The data type is specified by a DATAOBJECT record:


DATAOBJECT, data-type

The DATAOBJECT record can only appear once in each LDF, and must appear before the
EMBEDDED records. It identifies the plug-in handler that is to be used to handle the
embedded data. The data-type value determines which plug-in handlers will be used by the
book builder and Viewer.

The available Book Builder plug-ins and their data-type codes are defined in the
[BBPLUGINS] section of the LinkOne.ini file.
The available Viewer plug-ins and their data-type codes are defined in the [PLUGINS] section
of the LinkOne.ini file.

Both of these sections are configured during the installation procedure.

Embedded Files

Embedded files are specified by EMBEDDED records:


EMBEDDED, filename , “metadata ”

At least one EMBEDDED record must appear, otherwise the page will not be considered to
include any embedded data, and the plug-in handler will not be invoked.

The filename is optional. EMBEDDED records that omit the filename are used to just pass
metadata information to the plug-in handlers. If a filename is included, it identifies a source file
that is to be included in the target book as an embedded file for this page. Files that are
included on several pages are not duplicated; only one copy is placed in the target book. You
can specify a complete path - that is, the embedded file does not have to reside in the same
folder as the LDF file. You can use an absolute path, or a relative path (relative to the source
book folder).

The metadata is information about the embedded file that the plug-in handler needs to know.
The nature and format of this information is defined by the particular handlers.

Authoring HTML Documents


LinkOne version 4 includes a plug-in document handler that can handle and display any HTML
that is acceptable to the Internet Explorer 5.0 browser. This includes frames, animated GIFs
and scripts.

The handler is configured with a data type of “HTML”, so any embedded documents on a page
with a data type of “HTML” will be handled by the HTML handler.

List Definition Files

The version 3.1 record “STRING,HTML_FILE, filename ” is still supported, and can be used in
simple situations to associate an HTML document with a page. However, it is preferred that
you use the new version 4 records “DATAOBJECT” and “EMBEDDED” to associate your
HTML document with a page.

The appropriate DATAOBJECT record is:


DATAOBJECT,HTML

The metadata for the EMBEDDED records must be as follows:


“MASTER, relative-address” or
“ENTITY, relative-address ”

There should be one “Master” embedded file; this will be the HTML file that is opened for
display. All other embedded files should be listed as “Entity”. The Entity files will all be
available to the HTML plug-in while it is displaying the Master file.

The relative-address specifies the relative filename by which the HTML handler is to address
the file. This must be a relative path; you cannot use an absolute path. It represents the address
that the HTML handler considers the embedded file to have. This is particularly relevant to how
the files are addressed in the HTML you authored. There, you may have referred to graphics,
backgrounds, subframes and hyperlinks. Those need to have been authored with relative
addresses that correspond to the relative-address specified for the file in the metadata .

Normally, you will not need to go to any effort matching the addresses you author in your
HTML to the relative-addresses in the EMBEDDED records. If you store your HTML
documents in the source-book folder, or in sub-folders within the source-book folder, and only
use relative URLs in those documents, then the relative-address will be the same as the
filename. That is, your EMBEDDED records will all look like this:
EMBEDDED, filename , ”MASTER, filename ” or
EMBEDDED, filename , “ENTITY, filename ”

Where filename is the same each time. For example


EMBEDDED, graphics\logos\spinning.gif, “ENTITY,graphics\logos\spinning.gif”
and in your HTML you would reference
<IMG SRC=”graphics/logos/spinning.gif”>

Implicit Embedded Entity Files

You do not need to write EMBEDDED records to list every file needed by each HTML
document. The Book Builder HTML plug-in will scan the Master embedded file and identify
the graphics and sub-frames that the document uses. These files will be automatically included
as embedded files, even if they are not listed in EMBEDDED records. The plug-in will also
scan all sub-frames for further files to embedd and sub-sub frames to process.

The plug-in cannot identify all required files automatically. It will detect anything obviously
coded into the HTML, but if you use scripts to change image file names or sub-frames, the
plug-in will not be able to determine what files to embed. In these cases you will have to resort
to creating a manual list of EMBEDDED records to include the necessary files.
The plug-in can identify the following references to embedded files:
<INPUT SRC=xxx>
<BGSOUND SRC=xxx>
<IMG SRC=xxx>
<IMG DYNSRC=xxx>
<BODY BACKGROUND=xxx>
<FRAME SRC=xxx>
<LINK HREF=xxx>

Applying URL Filters

Your HTML documents can contain hyperlinks to external web sites; that is, live URLs on the
internet.
Clicking on such links will bring up the relevant web site within that page of the LinkOne
Viewer. If the user then tries to click on further hyperlinks on that web page, the links will not
function - they are disallowed.

You can add URL Filters to a page. These are a list of allowable URL addresses, or fragments
of URL addresses. Each hyperlink that the user clicks on is compared to the list of URL Filters.
If it matches one of the filters, it is accepted and will be processed.

You author a URL filter as a special form of EMBEDDED record:


EMBEDDED, , “URLFILTER,url-fragment”

Note the two commas where the filename field normally is found.

The URL-fragment represents a partial or complete URL, which is matched against the URL of
the hyperlink the user is trying to activate. If the filter ends in '/.', it indicates that to be
acceptable the URL must be for a file in the same path, but not in a subdirectory of that path.
Otherwise, the URL is acceptable if it contains the specified fragment anywhere.

For example:

URL Filter Would match

http://www.mincom.com http://www.mincom.com/linkone/downloads/new.htm
http://www.mincom.com/main.htm
http://www.mincom.com.au/naughtystuff.htm

http://www.mincom.com/. http://www.mincom.com/main.htm
but not http://www.mincom.com/linkone/index.htm

www.mincom.com http://www.mincom.com/linkone/index.htm
http://www.somesite.net/files/www.mincom.com/stuff.htm

Authoring Hyperlinks
The hyperlink addressing mechanism for HTML documents has been enhanced. Now, when
you specify an HREF, you have a number of options:

HREF Meaning

HREF=”address” If the document is part of a LinkOne book, then go to


the LinkOne address specified. See LinkOne Hyperlink Addressing later
in this document for full details on LinkOne addresses.
If the document is from a captive web site, then treat the address as an
internet address and display the web page at that URL.

HREF=”LinkOne:address” Go to the LinkOne address specified. See LinkOne Hyperlink


Addressing later in this document for full details on LinkOne addresses.

HREF=”LinkOne:[dde-command] Send the specified DDE command to LinkOne (see the reference manual
for a list of the DDE commands)

HREF=”http://internet-address” Go to the Internet and display the web page at that URL.

HREF=”https://internet-address” Go to the Internet and display the web page at that URL.

Authoring SGML Documents


LinkOne version 4 includes a plug-in document handler that can handle and display SGML
data. It utilises the Synex Viewport engine to do this, and you must have both the Viewport
engine and the SGML plug-ins installed in order for the Book Builder or Viewer to handle
SGML files. The SGML plug-in and the Viewport engine form an optional add-on module,
which is separately licensed.

The handler is configured with a data type of “SGML”, so any embedded documents on a page
with a data type of “SGML” will be handled by the SGML handler.

List Definition Files

For SGML documents, you need to specify a DATAOBJECT record like this:
DATAOBJECT,SGML

You then need to list the relevant files in EMBEDDED records.

The metadata for the EMBEDDED records must be as follows:


“MASTER, system-name, public-name ” or
“STYLE, system-name , public-name, optional-style-ID” or
“SRCH_IDX_STYLE, stylesheet-filename” or
“ENTITY, system-name, public-name”

There must be one “Master” embedded file; this will be the SGML file that is opened for
display. There must be one “Style” embedded file; this will be the stylesheet that defines how
the SGML data is displayed. You can optionally include one SRCH_IDX_STYLE record, as
described below. All the other records should be “Entity” records.

The system-name specifies the filename which the SGML handler considers the embedded file
to have, although the handler never actually writes the file to that address. The public-name is
the public name by which the SGML document refers to this entity.

The optional-style-ID is a tag that allows you to select amongst multiple stylesheets at runtime,
using a selector in your Layout file. The Layout file would specify which stylesheet to use, by
nominating an optional-style-ID.

Generating Search Indexes

A SRCH_IDX_STYLE record is used to nominate a stylesheet to be applied by the Book


Builder, in order to generate the full-text search index. If you do not nominate a search-index
stylesheet, LinkOne uses the one listed in the STYLE record. The SRCH_IDX_STYLE
stylesheet can be used to control what text gets indexed.

Implicit Embedded Entity Files

You do not need to write EMBEDDED records to list every file needed by each SGML
document. You must explicitly create EMBEDDED records for the “Master” file and the
“Style” file. The Book Builder SGML plug-in will scan the Master embedded file and identify
all of the other external entities that it references. These entities will be automatically included as
embedded files, even if they are not listed in EMBEDDED records. The plug-in will determine
the appropriate system-name and public-name for each embedded file it identifies.

Authoring Hyperlinks

To author hyperlinks that LinkOne can recognise within your SGML, you need to add some
special tags to your SGML documents. These tags utilise an SGML mechanism known as an
Architectural Form to specify hyperlink information in a flexible manner.

There are three steps involved in authoring hyperlinks within SGML:

Step 1. Define the form that the hyperlink tags will take.

You have two forms to choose from here. You can (a) have hyperlink information
specified as an attribute within a tag, or (b) you can have hyperlink information as part
of the document data, marked as a hyperlink by special tags surrounding it.
Eg. (a) <sometag href="linkone-address"> Marked Text </sometag>, or
(b) <crossreftag> LinkOne Address </crossreftag>

To select one of these forms, you must add a processing instruction before the
DOCTYPE tag in your SGML documents.

For form (a), add <?ATTLINK #ARCHFORM linkone clink href "linkone"> before
the DOCTYPE tag in your document.

For form (b), add <?TAGLINK #ARCHFORM linkone clink "linkone"> before the
DOCTYPE tag in your document.

Step 2. Define the attribute or tag that is to be used within the document.

If you chose form (a) in step 1, you now have two options:

(1) Define a hyperlink tag, using the default 'href' attribute. For example, to define a
tag "crossref-1" which has an "href" attribute, put <!ATTLIST crossref-1 linkone
NAME #FIXED "clink" href CDATA #IMPLIED > into the DOCTYPE section of
your document.

(2) Define a hyperlink tag, using the some other attribute to specify the target address.
For example, to define a tag "crossref-2" which has an attribute "target", put
<!ATTLIST crossref-2 linkone NAME #FIXED "clink" linknames NAMES
#FIXED "href target" target CDATA #IMPLIED >into the DOCTYPE section of
your document.

Alternatively, if you chose form (b) in step one, you define a tag to be used to mark the
hyperlink addresses. For example, to define a tag "crossref-3" to mark hyperlink
addresses in the document, put <!ATTLIST crossref-3 linkone NAME #FIXED
"clink" linknames NAMES #FIXED "href #CONTENT" > into the DOCTYPE
section of your document.

Step 3. Author the hyperlinks in your SGML document.

For form (a) option (1), author the hyperlinks like this (using the example given before):
<crossref-1 href="linkone:/ARMY/RPS14071"> Army Field Kitchen </crossref-1>

For form (a) option (2), author the hyperlinks like this (using the example given before):
<crossref-2 target="linkone:/ARMY/RPS14071"> Army Field Kitchen </crossref-2>

For form (b), author the hyperlinks like this (using the example given before):
<crossref-3>/ARMF/RPS14071</crossref-3>

Authoring XML Documents


The LinkOne HTML plug-in is also capable of handling and displaying XML documents.
In this case you specify a DATAOBJECT type of “XML”
DATAOBJECT,XML

You must then list at least two EMBEDDED records,


EMBEDDED, xml-filename , “MASTER, relative-address” and
EMBEDDED, xsl-filename, “STYLE, relative-address”

These define the master XML document and the style sheet used to format the document for
display. If your XML document requires any other external files, you will have to manually
include EMBEDDED records for each of those files. At present there is no book builder plug-
in for XML, so it cannot automatically determine the additional files required.

Authoring Captive Web Sites


There are two ways to add a captive web site to a LinkOne book:

1 On a page with an HTML document you can author a hyperlink that specifies an http:
or https: URL. When you click on that link, the captive web site will be displayed.

2 Create a captive web site page. This has the benefit of giving the web site a linkone
address; that is, it will have a publisher, book, reference address to which other books
can link, and to which you can attach notes. You can also add pictures to the page, and
callouts that can link to anchors within the web site pages.

To create a captive web site page, you simply create an LDF file for a page, add a
“DATAOBJECT,HTML” record to it, and an EMBEDDED record like this:
EMBEDDED, , “WEBSITE, internet-address”

Where internet-address is the URL of the captive web site.

When you add a captive web site in either of these ways, you will be allowed to access the
specified internet-address and any other files (web pages) in the same location as that address.
However, if you want to be able to navigate to other addresses (including sub-directories below
the URL you specified), then you will have to add some “URLFILTER” information. These
filters are added as EMBEDDED records, and have been described in the section “Applying
URL Filters” under “Authoring HTML Documents”.

Automatically Generating LDF Files


The book builder can automatically generate LDF files for other document types. If you select
the option to automatically generate LDF files, then book builder will use a list of file types. It
will look in your source book folder for all files with those types. For any files that do not get
processed as a result of existing LDF files, book builder will create an LDF file that embeds it.

You can specify what file types the book builder will look for, by clicking the File Types…
button. The default is to just look for files of type “HTM”.

The question of what DATATYPE is assigned to files in the generated LDF files is determined
by a table of associations in the LinkOne.ini file. This table is in a section titled
[BBPLUGINMAP]. In this section you will find a series of records that specify
file-type = data-type

The standard configuration specifies that files of type “HTM”, “HTML” and “XML” will be
assigned a datatype of “HTML”. Files of type “SGM” and “SGML” will be assigned a
datatytpe of “SGML”.
At present, if you want to alter these mappings you will have to modify that section of the
LinkOne.ini file by hand.

Simplified Publishing Process


The Book Builder now automatically performs all of the administrative steps required to prepare
books for delivery. This includes:

• Keeping Book.lst and Man.lst files up to date. This used to require a separate process
initiated through the Setup program. Now both the Book Builder and LinkOne
Administration automatically keep these files up to date.

• Creating Catalog files (Book.cat). This used to require a separate process initiated through
the Book Manager program. Now the Book Builder automatically maintains the Book.cat
file.

• Compressing multi-file books into single-file books. Again, this used to require a separate
step using the Book Manager. Now Book Builder automatically compresses multi-file
books into single files, and automatically expands single-file books into multi-file when doing
incremental updates.

All of this behaviour is controlled through the “Build Mode” pulldown on the Book Builder
dialog. Here you can choose between six options:

Build for Internet Delivery (draft or release),


Build with Maximum Compression (draft or release), or
Build (draft or release).

The only thing to be aware of is that if you build with ‘Maximum Compression’ you will not be
able to add Supplied Notes to the target book. If you need to add Supplied Notes you should
use the normal Build, add the Notes, then use LinkOne Administration to compress the book
(on the Books tab, right-click on the book and click ‘compress’).Compressed books cannot be
delivered over the Internet.

Enhanced Security Control for Derived Books


Two new publishing features have been added for publishers who use the 'derived books'
capability. The new features allow you to hard-code Option Filters and Security Keys into your
derived books. This means that the master book - the 'base book' - can be locked from
unauthorised access, using a security lock.

The derived books that use that base book can have a security key built in, so they can access
the base book information. In addition they can have unchangable Option Filters built in, so they
can only see a specific view of the base book data.

To use these new features, you simply do the following:

To prevent users from directly viewing the base book:

1. Add a Security Lock to your base book.


2. Add a KEY record to the Book.inf of your derived book, specifying a security
key that matches the lock you specified in the base book. See below for the
syntax of a KEY record. You can use the Book Information Editor to add such
records.
To force particular option filters to be applied to a book (typically, a derived book):

1. Add one or more OPTVAL records to the Book.inf file of the book you wish
the filters to be applied to.

KEY Records

These records can be placed in a Book.inf file. The effect will be that the relevant book will be
considered to possess the specified Security Key, and be able to be derived from a base book
that contain the matching Security Lock.

The syntax of a KEY record is:

KEY,security-key

where security-key is the key code generated by your Locksmith program for the relevant lock
number.

OPTVAL Records

There are two forms of this record:

OPTVAL,name,value
and
OPTVAL,name,value,FIXED

The first form - the non-fixed options - cause the specified option filters to be applied whenever
the book is opened. However, these can then be altered or overridden by the user, either by
temporary or permanent option filters that they apply.

The second form applies a fixed option filter. These filters cannot be altered or overridden; they
will always apply while the book is open. In addition, fixed filters are not displayed in any of the
lists of currently active filters, so the user should not even be aware that they are being applied.

The name is the name of the Option - as you specified it when you defined the option originally
(eg. "SN" for the standard serial-number option).

The value is the option value you wish to filter for; for example, the specific serial number for an
SN option.

Version Compatability
If you use either the KEY aor OPTVAL records in a book, it will be built as a version 4 book,
even if you have asked that it be built as a version 3.1 book.
Remote Libraries
Remote Libraries are a feature that allows you to browse and read books on a remote web
server as if they were on your PC. If you need to access a large collection of books from a
server in the Internet, you can install the collection as a Remote Library instead of installing the
individual books.

Installing a Remote Library has the same effect as installing the individual books with the
“Minimal Download” option, except that the one step will make all of the books in that library
available. In addition, if the supplier maintaining the library adds new books they will
automatically become available on your computer.

To install a Remote Library , use the Book tab in LinkOne Administration:

1. Click the Add Library button


2. The Choose New Library dialog appears
3. Select a folder to store the Remote Library . For example, C:\Libraries\Remote. Use the
button to create new folders if you need to. Click Select when you have the desired
folder open.
4. The new Library folder will be added to the Active Libraries and Books list.
5. Click the Properties tab on the right-hand side of the LinkOne Administration window.
The properties for your new Library will be displayed.
6. In the URL box, type in the URL of the remote library (E.g.
http://www.mincom.com/linkone/books).
7. Tick the This is a Remote Library box.
8. In the Viewer Settings area, tick Use for all publishers , and in the Action box select
Update used pages. You can change the Check every setting if you wish.

The Remote Library is now installed and ready for use.

Using Remote Libraries

Each remote library folder that you create can be associated with just one remote web site. So,
if you want to access books from several web sites you will need to create a separate library
folder and LOC.NET for each one.

Unlike the system of using Setup to install books, and running the Robot program on a server to
keep those books up to date, when you use Remote Libraries each end-user PC running the
LinkOne Viewer must have access to the Internet. If they do not, you can set them to operate
in "Work Offline" mode (explained below) - however they will only be able to access whatever
books and pages are currently stored in the local cache.
You cannot use the Setup "Install Books" to install books to a library that has been set up as a
cache for a remote web site. Those locations can only act as caches; they cannot be used as
normal libraries.

When you use the Browse Books dialog you will find that all of the books at the various remote
libraries will appear in the browser, just as if those remote libraries were on your local LAN.
You will generally not be able to tell which books are local and which are remote - nor will you
need to know.

You can share a remote library amongst all the users on your LAN; ie a remote library folder
does not have to be on your hard drive, it can be on a shared LAN drive and used by many
people.

Minor New Features


In addition to the significant new features described elsewhere, Version 4.1 also incorporates a
variety of minor enhancements:

3rd-party Plug-in Selection List Processors.

To activate a plug-in selection list processor, put the DLL file in the same directory as the
LinkOne executable and add an entry to the [ImageLink] section of the LinkOne ini file
(LINKONE.INI in your Windows directory) that reads SelListDLL= DLL-file-name

When the selection list is visible, either floating or docked, the LinkOne viewer will call the
specified DLL with the current selection list contents each time the selection list is changed. If
the selection list is hidden then the viewer will call the DLL just before making the selection list
visible, or before saving it's contents or answering a DDE request for it's contents.

A display name option in selection lists.

There is a new parameter available for FIELD definition records in a selection list definition. It is
DISP=xxx and will specify a Display field name to be used in the Sort By list and as a column
header in the Automatic layout. Note that the predefined field names will already be translated
using the message file so it is only necessary to use this for user defined fields in the selection list.

An example custom selection list follows:


SELECTION_LIST_DEFINITION,Example Selection List
FIELD,Part Number,PARTNO,CRITERIA
FIELD,Description,PARTDESC
FIELD,Requested, QUANTITY,REQUESTED_QTY,DISP=Order

Save picture to a file.

There is a new command in the file menu to "Save Graphic". This will pop-up a save file dialog
and allows you to save the current picture to a file. The picture will always be saved as a 256
colour BMP (raster) file even if the original was a vector graphic.

New-Look 'Browse Books' dialog

The “Browse Books” dialog now has just a single ‘tree’ control displaying all of the publishers
and books in an expandable tree. You can also resize the dialog to make titles more visible.
Other than the change in appearance, it works the same way as in previous versions.

New Look for Text Notes

The appearance of text notes has been significantly changed. Text notes now appear in a 'slim
line' window, with just a title bar and the text. You can still resize and move the window.
Clicking anywhere on the window or outside the window will close the note.

There is an additional option for text notes, when you create them. The option "Hide caption
when viewing" will make the note appear like a tool- tip; just a text window and nothing else.
You can still resize the window, but you can't move it. The note window will always appear in
the top left corner. This may not appear very useful, but it is really intended to be used for notes
that get displayed by a DDE command. See the description of the enhanced [NOTE.VIEW]
command, below.

Print graphic and list on the same page.

There is a new STRING attribute that can be added to the BOOK.INF file or to individual
LDF files that controls the Print Page function. The syntax is:

STRING,PRINT_TEMPLATE, name

where name can be any one of the following:

SPLIT_FIXED Picture and List on same page


SEPARATE As now
NO_LIST Only print the picture

When the picture and list are printed on the same page, the user can choose portrait or
landscape in the print dialog. This new print page template setting prints each sheet of paper as
two halves, printing the first picture in the first half, (top if portrait, left if landscape) next in the
next half etc. When portrait is chosen, and a single sheet would have two list "halves", these are
merged into a single page.

When you choose Print Picture or Print List, each picture and list is printed on a full sheet.

Suppressing printing of lists.

The PRINT_TEMPLATE attribute, as mentioned above, can be used to suppress the printing
of list pages by specifying a value of NO_LIST. This would commonly be used on pages
where there are only pictures and no list entries, so that you do not get a blank sheet printed out
for the list, when printing the entire page.

Easier Control of Print Font Height

Previously, the font height used for printing parts lists and selection lists was set by an entry in
the LinkOne INI file. Now you will find there is a button on the List Font dialog that will allow
you to select the font height you wish to use for printing.

Enhanced Selection List Dialog

In version 4.1 the selection list can be floated on-screen, or docked in the window as you work.
Selection-list functions can be accessed through toolbar buttons on the dialog, or a right-click
menu in the dialog.

Unlimited Number of Pictures Per Page

Version 4.1 has no limit on the number of pictures you can have on a single page. You can use
explicit-association to identify the pictures, or you can use implicit-association.

As with version 3, if you have an LDF file named “1234”, which says it has two pictures,
LinkOne will look for picture files named “1234a” and “1234b”. The difference with version
4.1 is that (a) you can use long filenames, and (b) after you reach the “z” suffix for the 26th
picture, you switch to “_27”, “_28”, “_29” etc. for the subsequent pictures.

This ensures that existing source books are all still compatible, but you are no longer limited to
26 pictures.
The same new rules also apply to overlays.
Enhanced Table of Contents dialog.

The Table of Contents dialog now has two modes; "Page Order" mode and "True Hierarchy"
mode.

In "Page Order" mode the dialog displays the pages in the order that they appear in the book.
As far as possible the assembly-subassembly relationships are shown, but if a subassembly is
used in several places in the structure, this is not indicated. Also, if a sub-assembly does not
occur just after its parent assembly, its relationship will not be indicated in the Table of
Contents.

In "True Hierarchy" mode, the dialog displays the assembly-subassembly relationships of all the
pages. If one page is used as a subassembly in several places, it will appear in all of those
places. Duplicate occurrences of a page are indicated by a 'faded' page icon. The pages may
not appear in the order that they occur in the book.
A toolbar and right-click context menu have been added to the dialog to control which mode is
displayed. The
toolbar icons are:

Icon Name Function

Save Saves the table of contents information to a text file.


Expand All Expands the entire tree
Collapse All Collapses the entire tree, except for the currently
selected entry.
Page Order mode Shows the table of contents in page order
True Hierarchy mode Shows the table of contents in assembly-subassembly
hierarchy
Show previous duplicate Goes to the previous occurrence of a common
subassembly
Show next duplicate Goes to the next occurrence of a common subassembly
Information Pop-up information on the number of pages in the book
and entries in the table of contents

Note: If the page order in the book matches the true hierarchy order, then both the Page
Order mode button and the True Hierarchy mode button will be greyed out.

Easier Creation of Publisher-Supplied Category Icons

If you wish to supply custom Publisher Category icons with your books, you can do so simply
by creating a Buttons.bmp file and putting it in your the Publisher folder in your LinkOne Library
folder. The Buttons.bmp file should be 256 colour, 16 pixels high and as wide as necessary to
contain all of the 16x16 images you wish it to contain.

Customisable Buttons and Note Category Icons

Customisation of the button bitmaps and the category icons is now extremely easy. The only
tool that you require is a bitmap editor, such as Windows Paint.

The built-in images used for the category icons and the user interface are all found in a standard
256-colour Windows bitmap file, named Buttons.bmp, in the LinkOne Bin folder. This bitmap
is 16 pixels high and as wide as is necessary to fit all of the 16x16 images. You can add new
images for buttons and built-in categories by simply extending the bitmap to the right and adding
more 16x16 images to it.

Note that only OEM manufacturers who are rebadging LinkOne should consider
customise the standard Buttons.bmp.

Note also that the size of the buttons and category icons is determined by the height of the
standard Buttons.bmp file. If you wanted 48x48 pixel buttons, you could simply expand the
Buttons.bmp to be 48 pixels high (and expand all the images in it to be 48x48 pixels).

Finally, please be aware that LinkOne makes assumptions about what images it will find in the
standard Buttons.bmp. If you alter the ordinal position of any of the standard images, you will
get extremely odd results on your LinkOne Viewer interface.

Enhanced History Navigation

The Viewer now has a ‘forward’ command as well as ‘back’, as well as a tree control that will
display the entire path that you have traversed and allow you to jump back to any arbitrary
point.

The default interface only includes the ‘back’, ‘forward’ and ‘back to start of book’ controls.
The other history controls can be accessed by customising your user interface.

Enhanced Handling for Working Offline

If you have remote books or remote book locations set up on your PC, but you some times
need to work without a live connection to the Internet (for example, if you have a laptop which
you sometimes use on-site), an enhancement has been added for you.

In the File menu of the Viewer you will find a “Work Offline” command. If you select this
command it will become ticked, and remain that way until you select it again.
While “Working Offline” is ticked, the Viewer will not attempt to download any files from the
Internet, nor will it check the validity of your remote books or remote book location browse
lists. You will only be able to access the books and pages you have on your local hard drive.

In addition to this, if an error occurs while downloading files from a remote book or you cancel
the download, the Viewer will ask you whether you would like to work offline for the remainder
of your LinkOne session. If you say yes, then “Work Offline” will become ticked; however, in
this case the Viewer will not remember the setting, and the next time you start LinkOne it will
once again be working online.

Language Translation and Rebadging

You can translate Version 4.1 into different languages simply by creating text “message files”.
Message files that were created for version 3.1 will still work with version 4.1, but there will be
some new messages and dialog items that will require additional translations to be added. There
are also a few messages that have been reworded, and the 3.1 translations of those messages
will need to be updated.

The message files used by LinkOne are:

• LINK1.MSG
• VIEW.MSG
• PUB.MSG

Language-specific versions of these files are identified by adding an ISO-639 language code
prefix; for example DE_LINK1.MSG for German messages.

Printing a Book as a Single Print Job

Version 4 Viewer now does ‘print book’ jobs as a single large print job, instead of a separate
print job for each page. You can make it revert to creating a separate job per page by setting a
flag in the [ImageLink] section of the LinkOne.ini file:

[ImageLink]
PrintAsSingleJob=FALSE

New DDE Commands

Some new DDE commands have been added to LinkOne. These can be used from other
applications, or from LinkOne: protocol hyperlinks in HTML or SGML documents, or from
Program Notes in the Viewer.
The new commands are:

[SELECT.FITTED]
Adds the currently highlighted parts list entry to the selection list, setting the
quantity requested to be the same as the quantity fitted indicated in the parts list.

[TOOLBAR.SHOW(name)]
Makes the specified toolbar visible. The toolbar name is the name of the
toolbar, as shown in the Scheme tab in the Customise dialog.

[TOOLBAR.HIDE(name)]
Makes the specified toolbar invisible. The toolbar name is the name of the
toolbar, as shown in the Scheme tab in the Customise dialog.

[TOOLBAR.FLOAT( name ,x,y,w,h)]


Makes the specified toolbar visible and displays it as a floating window
positioned at the screen coordinates (x, y). The size of the floating window will
be no more than w pixels wide and h pixels high, and may be smaller if the
toolbar does not require the entire w or h specified. The toolbar name is the
name of the toolbar, as shown in the Scheme tab in the Customise dialog.

[SELECTIONS.HIDE]
This hides the selection list, if it is visible. It is equivalent to
[toolbar.hide(Selection List)].

[SELECTIONS.SHOW]
Makes the selection list visible. It is equivalent to [toolbar.show(Selection
List)].

[SELECTIONS.FLOAT(x,y,w,h)]
Makes the selection list visible, and displays it as a floating window positioned
at the screen coordinates (x, y). The size of the floating window will be w pixels
wide and h pixels high. It is equivalent to [toolbar.float(Selection List,x,y,w,h)].

[SELECTIONS.REFRESH]
Causes the selection list display to be updated to reflect the current selection list
contents. In normal circumstances this does not need to be done, but to if you
are using a plug-in selection-list processing DLL, this DDE command can be
used to cause your DLL to be called.

[NOTE.VIEW(name,x,y)]
This is an enhancement to the existing [NOTE.VIEW] command. This
enhancement applies only to text notes, and it will display the note at the
specified position in the LinkOne window. The x and y can be arithmetic
expressions, including "+", "-", "*", "/" and "( )". In addition to numbers, you
can include special values in the expression:

left or l the current horizontal


mouse position.

right or r the current horizontal mouse


position minus the width of the dialog.

top or t the current vertical


mouse position.

bottom or b the current vertical mouse


position minus the height of the dialog.

middle or m or centre or c if we are parsing the x value the current


horizontal mouse position minus half the width
of the dialog else if we are parsing the y value
the current vertical mouse position minus half
the height of the dialog

Book Builder Command-Line Switches

The complete set of command-line switches that you can use with the Version 4 Book Builder
is:

Switch Description

-BUILD value Instructs Book Builder which build method to use. Values allowed are:
FULL , INCREMENTAL and TEST.

-SD value Specifies the Source Directory. The specified directory will be
displayed in the Source edit box.

If this switch is not included in the command line for the initial build for
the book, Book Builder will display a message requesting that the
source directory be specified.
Note that this switch must be positioned at the end of the command line
if you are creating a Tool in Hotpoint and you wish to use the Load
Current Book.INF File radio button to build the current book.

-TD value Specifies the Target Directory. The specified directory will be displayed
in the Target edit box.

If this switch is not included in the command line for the initial build for
the book, Book Builder will display a message requesting that the target
directory be specified.

-COMPRESS Compress the target file into a single-file book (equivalent of the
'maximum compression' build option).

-NOCOMPRESS Build target as a multi-file book. (Equivalent of normal build option and
'internet' build option)

-PH value Specifies the maximum Picture Height. All pictures will be scaled to be
no more than the specified number of pixels high. The default is 976
pixels.

-PW value Specifies the maximum Picture Width. All pictures will be scaled to be
no more than the specified number of pixels wide. The default is 986
pixels.

-V3 Instructs Book Builder to build a Version 3 book.

-V4 Instructs Book Builder to build a Version 4 book. This is the default
setting.

-PB Production Build. Instructs Book Builder to carry out a production


build.

-DB Draft Build. Instructs the Book Builder to perform a draft build. This is
the default setting.

-IDA Instructs Book Builder to audit Item IDs.

-SBR Instructs Book Builder to suppress the creation of a Book Report.

-SPR Instructs Book Builder to suppress the creation of a Parts Report.


-NOMSG Suppresses any message about error logs, or about the book needing a
total rebuild. Mainly for use when running Book Builder as an
unattended batch process.

Note that fatal error messages and "Quota Exceeded" messages will still
appear.

-LDFS Auto-generate LDF files (pages) for any external document file not
currently referred to by a page (by default, any .HTM file)

-NLS filename Use the specified message file.

New Media-Linked Viewer Behaviour

The licensing of the media-linked viewers has been changed. Previously media-linked viewers
could read any books on the same media, regardless of who published them. Now they can
only read books whose publisher code matches the publisher code of the media-linked viewer
license.

Drag and Drop into Hotpoint

You can now drag and drop LDF files into Hotpoint, to edit them.
LinkOne Hyperlink Addressing
LinkOne now has a standard way of expressing addresses. The LinkOne address expressions
are compatible with HTML URLs, and can also be used in SGML or XML documents.

A LinkOne Address can take any form that fits the following syntax definition:

Text in quotes and bold - ‘example’ - represents literal text in the address expression.
Text in italics - example - indicates elements that are defined further.
Text in brackets - [example] - indicates optional elements.

Address Element Allowed Forms Comments


hyperlink [ 'linkone:' ] [ generic | specific ] [ ‘#’ fragment ]

Address Element Allowed Forms Comments


generic absolute
relative
absolute '/' publisher '/' book [ '/' page ]
relative page

Address Element Allowed Forms Comments


publisher '*'
publisher-code publisher-code is a standard LinkOne publisher code.
book '*' '*' is only valid if publisher is '*'
book -code book-code is a standard LinkOne book code
page '@' bookmark bookmark is the name of a bookmark visible in the
relevant book.
reference-code reference-code is a standard LinkOne page reference code.
'*' '*' is only valid if book is '*' or address is relative.

Address Element Allowed Forms Comments


specific 'cs?' [ spec [ '&' spec ]… ] see remarks for valid combinations of spec.

Address Element Allowed Forms Comments


spec Objectspec
itemspec
slotspec
pubspec
bookspec
pagespec
objectspec 'object=' equipment-id Equipment ID is defined in the Configuration Server
database
itemspec 'item=' item-id
slotspec 'slot=' slot-name Slot names are defined in the Configuration Server database
pubspec 'publisher=' publisher-code publisher-code is a standard LinkOne publisher code.
bookspec 'book=' book-code book-code is a standard LinkOne book code
pagespec 'page=@' bookmark bookmark is the name of a bookmark visible in the
relevant book.
‘page=’ reference-code reference-code is a standard LinkOne page reference code.

Address Element Allowed Forms Comments


fragment item-id A standard LinkOne Item ID.

Remarks
Fragments

Any address form can have a fragment. An address that contains only a fragment refers to all
documents on the same page as the linking element. In LinkOne version 4 the fragment is
always an item id. Each document type can have it’s own interpretation of item-id. For HTML
this is an anchor with a matching name attribute. For LinkOne graphics it is all the graphic
objects with a matching item-id. For a LinkOne parts list it is all the entries with a matching
item-id. For SGML it is the element with a matching ID attribute.

Generic Addressing

Generic addressing has two forms, absolute and relative.

Relative generic addressing is used for intra book addressing or to address a specific document
or document group on the same page as the linking element. This form contains just a page
reference. The page reference can be the asterisk character (*) which means the current page.

Some examples of relative addresses:

201 page 201 (the page in the current book with the reference 201)
201#14 item 14 on page 201
#12 item 12 on the current page

Absolute generic addresses start with a slash (/) character and can contain 2 or 3 components
separated by slash (/) characters. The first component is the publisher code or an asterisk (*)
which signifies the same publisher as the current book. The second component is the book
code. If the publisher code is an asterisk then the book code can also be an asterisk meaning
the current book. Setting both the publisher and book codes to asterisk is the same as
specifying a relative address. The third component is the page reference. If the absolute address
only has two components then the first page in the book is assumed.

Some examples of absolute addresses:

/*/PC240 the first page in book PC240 from the current publisher
/ACME/SUPER-80 the first page in book SUPER-80 from publisher ACME
/*/PC240/201#18 item 18 on page 201 in book PC240 from the current publisher
Specific addressing

Specific addresses are resolved with a configuration server - an application external to LinkOne
that maps specific real world objects to the information that describes them. A configuration
server has access to a database that maps these real world objects to LinkOne books.

All specific addresses start with the string “cs?”. Between this prefix, called the query, and the
fragment, you can specify a number of name value pairs separated by ampersand characters
(&). These attributes are:

Attribute Meaning
object a unique specific object identifier (equipment no or asset no)
slot a code that corresponds to a position in a piece of equipment where a component
can be mounted
item the code used to look up the slot code for a link, corresponding to the item-id for
an entry in a parts list that contains an inter-book link
publisher a publisher code used to build a generic address that is used when a specific
address can not be constructed
book a book code used to build a generic address that is used when a specific address
can not be constructed
page a page in the target book

If a specific address does not contain an object, slot or item attribute then it is treated the same
as a generic address where the publisher, book and page values correspond to the three
components of a generic absolute address. In this case missing attributes are treated as having
the value “*”. This means that the address “cs?#12” is legal and is semantically the same as
“/*/*/*#12” which is also the same as “*#12” or just “#12”.

If a specific address specifies an object, slot or an item then LinkOne attempts to resolve this by
asking the configuration server for information if there is one installed. In some cases the
configuration server will not be able to resolve this query. What happens then depends on if the
query is deemed to have a generic component and how the specific query resolution fails. A
generic component exists if there is a book attribute specified.

If the specific query can be resolved by configuration server:

Attributes specified Action


object Clear existing options. Open book and set options for object.
object and slot Clear existing options. Set options for object prepended with a “P”. Set options
and open the book for object fitted to the slot.
slot Set options for current object prepended with a “P”. Set options and open the
book for object fitted to the slot.
item Set options for current object prepended with a “P”. Set options and open the
book for object fitted to the slot specified by item.

If the specific query can not be resolved by configuration server:


attributes specified reason action
object object not known message “Don’t know which book
to open for object”
object no configuration server installed. message "Unable to follow this link.
The Configuration Server was
unable to resolve this address."

attributes specified reason action


object & generic component no configuration server installed follow generic link, clear current
options
object & generic component object not known message “Don’t know which book
to open for object…Follow generic
link?”

attributes specified reason action


object & slot no configuration server installed. message "Unable to follow this link.
The Configuration Server was
unable to resolve this address."
object & slot object not known message “Don’t know which book
to open for object”
object & slot no object fitted in slot message “Nothing fitted to position
slot”

attributes specified reason action


object, slot & generic component no configuration server installed follow generic link, clear current
options
object, slot & generic component object not known error message “Don’t know which
book to open for object…Follow
generic link?”
object, slot & generic component no object fitted in slot message “Nothing fitted to position
slot…Follow generic link?”

attributes specified reason action


slot no current specific object message "Unable to follow this link.
The Configuration Server was
unable to resolve this address."
slot no object fitted in slot message “Nothing fitted to position
slot”

attributes specified reason action


slot & generic component no current specific object follow generic link, clear current
options
slot & generic component no object fitted in slot message “Nothing fitted to position
slot…Follow generic link?”

attributes specified reason action


item no current specific object message "Unable to follow this link.
The Configuration Server was
unable to resolve this address."
item no slot defined for item message "Unable to follow this link.
The Configuration Server was
unable to resolve this address."
item no object fitted to slot message “Nothing fitted to position
slot”
attributes specified reason action
item & generic component no current specific object follow generic link, clear current
options
item & generic component no slot defined for item follow generic link, clear current
options
item & generic component no object fitted to slot message “Nothing fitted to position
slot…Follow generic link?”

If the user answers the question “Follow generic link?” by pressing the yes button, then clear
current options and follow the link. If he answers no then leave the current state unchanged.

Bookmark addressing

The page reference in a generic or specific address can start with an ampersand (@) which
looks for a bookmark of that name. It will only look for Book-level bookmarks. It will not
look for Publisher or Global bookmarks. If it cannot find a bookmark of that name it treats the
bookmark name as a page reference code.

Escaping Special Characters in an address

All characters are currently allowed in LinkOne page references and item-id’s. Some of these
will cause problems in a LinkOne address, like slash (/) or hash (#) in a publisher, book or
page, commercial at sign (@) as the first character of a page reference or a left parentheses (‘(‘)
or slash (‘/’) in an item-id. These must be escaped using the url escaping mechanism - a percent
sign followed by two hexadecimal characters that specify the character value. The percent sign
character must also be escaped anywhere in a LinkOne address.

character escape sequence


/ %2f
# %23
@ %40
% %25
( %28

HTML, XML and SGML Escaping

Some characters must be escaped in HTML, XML and SGML attribute values or content. You
must use the character entity reference when it is necessary.

character standard entity reference


& &amp;
< &lt;
> &gt;
' &apos;
" &quot;

You might also like