3. Generating Documentation Packages

Generation is driven from the Generate Documentation dialog. You pick a packager (see 4. The Packagers Compared), then answer the same set of questions whichever packager it is.

What you choose at generation time

Choice	What it means
Package name	Name of the output package
Output directory / Data Repository	Where the package folder is written
External resources	A folder of extra content to fold in (see below)
Include the viewer application	A full package carries its own viewer; a data-only package does not, and is smaller and faster to build
Scope	Which harness designs (including derivatives), wiring designs or logic designs go in
Designs to compare	Change Explorer only: the two design versions being compared
Artifacts	Lean SVG diagrams, embedded reports, 2D location links, 3D, and so on
Configuration tab	A pre-built vehicle configuration, which filters the designs automatically
Effectivity tab	A pre-calculated effectivity range
Background Run	Send the job to the Capital Integration Server instead of running it locally (see 5. Background Generation with FEM)

The external resources folder

Resources are not part of the project; they are a folder you point at. Two sub-folders have special behaviour:

• introduction: anything in here (Word, PDF, HTML, anything a browser can open) appears in the Information section of the viewer.
• TwoDviews: SVG and PDF location drawings. During generation Publisher scans their text for names of wires, backshells, connectors, ring terminals and devices and turns every match into a live link. No manual hotspot work is needed if the names match.

Save HTML resources as UTF-8, or special characters display wrongly in Service Explorer.

Full packages, data-only packages and the Package Manager

A package is a self-contained folder: copy it to a server, a memory stick or a tablet and it works. To avoid shipping the same viewer over and over, you can build data-only packages and view them with a viewer generated earlier for the same packager type.

The Package Manager is how a viewer finds data-only packages. It lists packages in a table and lets you add repository folders, move, rename, re-describe and remove packages.

It is off by default. To get one, set <include-package-manager>true</include-package-manager> in publisher\config.xml and generate again; CapitalPackageManager.exe then appears in the root of the output folder. Its display language is set per packager in publisher\server-config\<packager>.xml (<package_manager_locale>).

Checking the result

Generation reports feedback per package (Package Generation Feedback in the vendor guide). Read it: an artifact whose inputs were missing (no 2D views, no fault codes property, a logic and harness pair out of sync) is typically skipped rather than failed. Open the package and look for the content you expected before calling it done.

Vendor pages

ee-publisher/: Generating Documentation, Generate Documentation Dialog, Available Artifacts, Managing Documentation Packages, Package Generation Feedback.