EKGF Editor's Draft

Documentation Publication Model 1.0

EKGF Editor's Draft

Specification PDF

Abstract§

This specification defines a model for publishing shared documentation fragments as independently arranged web specifications and review documents.

Status of This Document§

This illustrative draft demonstrates Grapharch publication. The publication metadata and all document content are read from the pinned documentation graph.

1. Introduction§

A publication is a view of a validated documentation graph. Authors can maintain content independently of a particular output format.

1.1 Data model§

The model separates subjects, fragments, components, placements, and publication targets.

1.1.1 Identity§

A fragment retains its identity when reused in another publication. The string <example> is rendered as literal source text.

1.2 Reading conventions§

The key words MUST, SHOULD, and MAY in this illustrative document describe requirements on a publication implementation.

2. Publication requirements§

A publisher MUST read a complete, validated graph revision. It MUST NOT publish partial collector contributions.

2.1 Target bindings§

BindingPurpose
ScopeSelect documentable subjects
ProfileArrange logical components
RendererProduce a publication format

2.2 Example§

<urn:example:target> <https://ekgf.org/ontology/grapharch#renderer> <https://ekgf.org/ontology/grapharch#SpecificationRenderer> .

A. Change history§

Initial illustrative draft demonstrating graph-backed specification publication.

References§

B. Document provenance§

This record identifies the generator and the source revisions collected for this publication.

GeneratorGraphArch 0.2.29 (build 412)
Generator commit8908a9610d77

No Git repository revision was recorded for these sources.

Search this specification