Skip to content

Documentation cleanup #270

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tviegut merged 2 commits into from
Jul 8, 2026
Merged

Documentation cleanup #270

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8484653
Introduced the prefix mappings file feature in the documentation HOW …
tviegut Jun 23, 2026
a112f38
Documentation and public site updates
tviegut Jun 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions dev-docs/Includes/CIMToolFeature/CIMToolFeature-README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ provisioning system.


[[status]]
=== Current Status — Legacy / Dormant
=== Current Status: Legacy / Dormant

CIMToolFeature is **not actively used** in the current build and packaging
workflow. The definitive indicator is the `useFeatures="false"` attribute in
Expand Down Expand Up @@ -58,9 +58,9 @@ produced by the PDE product export in `CIMToolProduct`.

When active, an Eclipse PDE feature serves two purposes:

. *Packaging* — groups a set of plugins into a single installable unit for
. *Packaging*: groups a set of plugins into a single installable unit for
deployment via an Eclipse p2 update site
. *Dependency declaration* — declares the minimum plugin versions required for
. *Dependency declaration*: declares the minimum plugin versions required for
the feature to function correctly

CIMToolFeature (`au.com.langdale.cimtoole.feature`) groups the full set of
Expand Down Expand Up @@ -136,12 +136,12 @@ following steps would be required:

=== Relationship to Other Projects

* *CIMToolProduct* — the active replacement for this project's packaging role.
* *CIMToolProduct*: the active replacement for this project's packaging role.
`CIMTool.product` with `useFeatures="false"` performs plugin-based packaging
directly, making this feature project redundant in the current workflow.

* All plugins listed in `feature.xml` (`au.com.langdale.cimtoole`,
`au.com.langdale.cimtoole.help`, `au.com.langdale.kena`,
`au.com.langdale.rcputil`, `au.com.langdale.cimutil`,
`com.cimphony.cimtoole`) are active projects — only this feature wrapper is
`com.cimphony.cimtoole`) are active projects; only this feature wrapper is
dormant.
10 changes: 5 additions & 5 deletions dev-docs/Includes/CIMToolFeature/CIMToolFeature-README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ provisioning system.



## Current Status — Legacy / Dormant
## Current Status: Legacy / Dormant

CIMToolFeature is **not actively used** in the current build and packaging
workflow. The definitive indicator is the `useFeatures="false"` attribute in
Expand Down Expand Up @@ -44,8 +44,8 @@ produced by the PDE product export in `CIMToolProduct`.

When active, an Eclipse PDE feature serves two purposes:

1. **Packaging** — groups a set of plugins into a single installable unit for deployment via an Eclipse p2 update site
2. **Dependency declaration** — declares the minimum plugin versions required for the feature to function correctly
1. **Packaging**: groups a set of plugins into a single installable unit for deployment via an Eclipse p2 update site
2. **Dependency declaration**: declares the minimum plugin versions required for the feature to function correctly

CIMToolFeature (`au.com.langdale.cimtoole.feature`) groups the full set of
in-repository CIMTool plugins plus the license and release note text files that
Expand Down Expand Up @@ -104,5 +104,5 @@ following steps would be required:

## Relationship to Other Projects

- **CIMToolProduct** — the active replacement for this project's packaging role. `CIMTool.product` with `useFeatures="false"` performs plugin-based packaging directly, making this feature project redundant in the current workflow.
- All plugins listed in `feature.xml` (`au.com.langdale.cimtoole`, `au.com.langdale.cimtoole.help`, `au.com.langdale.kena`, `au.com.langdale.rcputil`, `au.com.langdale.cimutil`, `com.cimphony.cimtoole`) are active projects — only this feature wrapper is dormant.
- **CIMToolProduct**: the active replacement for this project's packaging role. `CIMTool.product` with `useFeatures="false"` performs plugin-based packaging directly, making this feature project redundant in the current workflow.
- All plugins listed in `feature.xml` (`au.com.langdale.cimtoole`, `au.com.langdale.cimtoole.help`, `au.com.langdale.kena`, `au.com.langdale.rcputil`, `au.com.langdale.cimutil`, `com.cimphony.cimtoole`) are active projects, and only this feature wrapper is dormant.
6 changes: 3 additions & 3 deletions dev-docs/Includes/CIMToolHelp/CIMToolHelp-README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ that contributes to the `org.eclipse.help.toc` extension point, registering
`toc.xml` as the table of contents for the CIMTool help system. All content is
static HTML stored in the `html/` directory.

The documentation covers the full range of CIMTool user topics — from getting
The documentation covers the full range of CIMTool user topics, from getting
started and importing EA models through to profiling, validation, namespace
management, and OWL/RDF concepts — and is displayed directly within the Eclipse
management, and OWL/RDF concepts, and is displayed directly within the Eclipse
Help viewer.


Expand Down Expand Up @@ -178,7 +178,7 @@ All documentation is hand-authored HTML. To add or update a topic:
. Add or edit the HTML file in `html/`
. If adding a new topic, add a `<topic>` entry to `toc.xml` referencing it via
the `PLUGINS_ROOT/au.com.langdale.cimtoole.help/html/<filename>.html` path
. Rebuild and re-export the product — no Java compilation is required
. Rebuild and re-export the product, with no Java compilation required

NOTE: The `PLUGINS_ROOT/` prefix in `toc.xml` href values is an Eclipse help
framework convention that resolves to the installed plugins directory at runtime.
Expand Down
6 changes: 3 additions & 3 deletions dev-docs/Includes/CIMToolHelp/CIMToolHelp-README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ that contributes to the `org.eclipse.help.toc` extension point, registering
`toc.xml` as the table of contents for the CIMTool help system. All content is
static HTML stored in the `html/` directory.

The documentation covers the full range of CIMTool user topics — from getting
The documentation covers the full range of CIMTool user topics, from getting
started and importing EA models through to profiling, validation, namespace
management, and OWL/RDF concepts — and is displayed directly within the Eclipse
management, and OWL/RDF concepts, and is displayed directly within the Eclipse
Help viewer.


Expand Down Expand Up @@ -125,7 +125,7 @@ All documentation is hand-authored HTML. To add or update a topic:
1. Add or edit the HTML file in `html/`
2. If adding a new topic, add a `<topic>` entry to `toc.xml` referencing it via
the `PLUGINS_ROOT/au.com.langdale.cimtoole.help/html/<filename>.html` path
3. Rebuild and re-export the product — no Java compilation is required
3. Rebuild and re-export the product, with no Java compilation required

> **Note:** The `PLUGINS_ROOT/` prefix in `toc.xml` href values is an Eclipse
> help framework convention that resolves to the installed plugins directory at
Expand Down
Loading
Loading