https://github.com/transpect/transpectdoc
Generates a Code Reference for a Transpect Project
https://github.com/transpect/transpectdoc
Last synced: 4 months ago
JSON representation
Generates a Code Reference for a Transpect Project
- Host: GitHub
- URL: https://github.com/transpect/transpectdoc
- Owner: transpect
- License: bsd-2-clause
- Created: 2016-02-05T14:40:20.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-01-14T09:07:33.000Z (over 2 years ago)
- Last Synced: 2025-03-02T13:17:13.049Z (over 1 year ago)
- Language: XSLT
- Homepage:
- Size: 932 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# transpectdoc
This pipeline documents all pipelines and library that are used in a project.
# Description
The source documents are considered as the front-end pipelines. All other imported libraries and steps will be crawled.
For each of the steps’ input and output ports, a linked list will be generated that points to the ports in other pipelines that are connected to these ports.
# Invocation
Sample invocation (from a Makefile):
```
FRONTEND_PIPELINES = adaptions/common/xpl/idml2hobots.xpl adaptions/common/xpl/hobots2epub-frontend.xpl crossref/xpl/process-crossref-results.xpl crossref/xpl/jats-submit-crossref-query.xpl
transpectdoc: $(addprefix $(MAKEFILEDIR)/,$(FRONTEND_PIPELINES))
$(CALABASH) $(foreach pipe,$^,$(addprefix -i source=,$(call uri,$(pipe)))) \
$(call uri,transpectdoc/xpl/transpectdoc.xpl) \
debug=$(DEBUG) debug-dir-uri=$(call uri,$(MAKEFILEDIR)/transpectdoc/debug)
```
Set the svn property `svn:mime-type` for the `transpectdoc.css` in your documentation output directory to text/css, if you want to view the generated documentation online, not only locally.
For customizing transpectdoc, there are three XSLT passes whose templates etc. may be overridden by specifying, e.g.:
```
-i crawling-xslt=$(call uri,adaptions/common/transpectdoc/xsl/pubcoach-crawl.xsl \
-i connections-xslt=$(call uri,adaptions/common/transpectdoc/xsl/pubcoach-connections.xsl \
-i rendering-xslt=$(call uri,adaptions/common/transpectdoc/xsl/pubcoach-render-html-pages.xsl
```
within the calabash.sh invocation (provided the files reside there, of course).
# Adding Examples for Dynamically Evaluated Pipelines
If your pipeline loads and executes pipelines at runtime, i.e., pipelines that are not known statically in advance, you may provide examples for these pipelines. Examples:
```
…
…
```
Since the examples to the evolve-hub `tr:dynamic-transformation-pipeline` will vary from project to project, it is impractical to provide one single set of examples for this pipeline. Instead, you provide the examples at the `tr:evolve-hub` invocation in your project’s pipeline. In the @for attribute, you tell transpectdoc that the examples are for the input port called 'pipeline' of `tr:dynamic-transformation-pipeline` (provided that this port has an xml:id of 'eval-pipeline').
The front-end pipelines of the transpect installation.
XSLT should generate title according to default rules if empty string is submitted
The operating system path for the output directory (with forward slashes). Whitespace is not supported.
Makes implicit primary port connections explicit. As an unrelated side effect, will normalize plain text and DocBook markup within p:documentation elements to HTML. Always create the output directory. Otherwise (i.e. first time) a java.io.FileNotFoundException will raise. Aaargh