{"id":20079583,"url":"https://github.com/transpect/transpectdoc","last_synced_at":"2026-03-04T18:32:04.483Z","repository":{"id":93859606,"uuid":"51151874","full_name":"transpect/transpectdoc","owner":"transpect","description":"Generates a Code Reference for a Transpect Project","archived":false,"fork":false,"pushed_at":"2024-01-14T09:07:33.000Z","size":954,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-02T13:17:13.049Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"XSLT","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/transpect.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-02-05T14:40:20.000Z","updated_at":"2024-01-04T19:47:06.000Z","dependencies_parsed_at":"2024-11-13T15:36:02.922Z","dependency_job_id":null,"html_url":"https://github.com/transpect/transpectdoc","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/transpect/transpectdoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transpect%2Ftranspectdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transpect%2Ftranspectdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transpect%2Ftranspectdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transpect%2Ftranspectdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/transpect","download_url":"https://codeload.github.com/transpect/transpectdoc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transpect%2Ftranspectdoc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30089339,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-04T18:31:08.343Z","status":"ssl_error","status_checked_at":"2026-03-04T18:31:07.708Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T15:23:31.435Z","updated_at":"2026-03-04T18:32:04.458Z","avatar_url":"https://github.com/transpect.png","language":"XSLT","funding_links":[],"categories":[],"sub_categories":[],"readme":"# transpectdoc\n\nThis pipeline documents all pipelines and library that are used in a project.\n\n# Description\n\nThe source documents are considered as the front-end pipelines. All other imported libraries and steps will be crawled.\n\nFor 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.\n\n# Invocation\n\nSample invocation (from a Makefile):\n\n```\nFRONTEND_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\ntranspectdoc: $(addprefix $(MAKEFILEDIR)/,$(FRONTEND_PIPELINES))\n\t      $(CALABASH) $(foreach pipe,$^,$(addprefix -i source=,$(call uri,$(pipe)))) \\\n\t      \t\t  \t    $(call uri,transpectdoc/xpl/transpectdoc.xpl) \\\n\t\t\t\t    debug=$(DEBUG) debug-dir-uri=$(call uri,$(MAKEFILEDIR)/transpectdoc/debug)\n```\n\nSet 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.\n\nFor customizing transpectdoc, there are three XSLT passes whose templates etc. may be overridden by specifying, e.g.:\n\n```\n-i crawling-xslt=$(call uri,adaptions/common/transpectdoc/xsl/pubcoach-crawl.xsl \\\n-i connections-xslt=$(call uri,adaptions/common/transpectdoc/xsl/pubcoach-connections.xsl \\\n-i rendering-xslt=$(call uri,adaptions/common/transpectdoc/xsl/pubcoach-render-html-pages.xsl \n```\n\nwithin the calabash.sh invocation (provided the files reside there, of course).\n\n\n\n# Adding Examples for Dynamically Evaluated Pipelines\n\nIf 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:\n\n```\n\u003ctr:dynamic-transformation-pipeline load=evolve-hub/driver\" fallback-xpl=\"fallback.xpl\"\u003e\n    \u003cp:pipeinfo\u003e\n      \u003cexamples xmlns=\"http://transpect.io\"\u003e\n        \u003cfile href=\"fallback.xpl\"/\u003e\n      \u003c/examples\u003e\n    \u003c/p:pipeinfo\u003e\n    \u003c/tr:dynamic-transformation-pipeline\u003e\n\u003ctr:dynamic-transformation-pipeline load=\"hub2hobots/hub2hobots\"\u003e\n  …\n  \u003cp:pipeinfo\u003e\n    \u003cexamples xmlns=\"http://transpect.io\"\u003e \n      \u003ccollection dir-uri=\"http://this.transpect.io/a9s/\" file=\"hub2hobots/hub2hobots.xpl\"/\u003e\n      \u003cgenerator-collection dir-uri=\"http://this.transpect.io/a9s/\" file=\"hub2hobots/hub2hobots.xpl.xsl\"/\u003e\n    \u003c/examples\u003e\n  \u003c/p:pipeinfo\u003e\n\u003c/tr:dynamic-transformation-pipeline\n```\n\nPlease note that the generator-collection element is not implemted yet. It is meant for holding pointers to XSLT stylesheets that generate the dynamically evaluated pipelines.\n\nThere is an optional attribute @for on the examples element:\n\n```\n\u003ctr:evolve-hub name=\"evolve-hub-dyn\" srcpaths=\"yes\"\u003e\n  …\n  \u003cp:pipeinfo\u003e\n    \u003cexamples xmlns=\"http://transpect.io\" \n      for=\"http://transpect.io/cascade/xpl/dynamic-transformation-pipeline.xpl#eval-pipeline\"\u003e\n      \u003ccollection dir-uri=\"http://this.transpect.io/a9s/\" file=\"evolve-hub/driver.xpl\"/\u003e\n      \u003cgenerator-collection dir-uri=\"http://this.transpect.io/a9s/\" file=\"evolve-hub/driver.xpl.xsl\"/\u003e\n    \u003c/examples\u003e\n  \u003c/p:pipeinfo\u003e\n\u003c/tr:evolve-hub\u003e\n```\n\nSince 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').\n\nThe front-end pipelines of the transpect installation.\n\nXSLT should generate title according to default rules if empty string is submitted\nThe operating system path for the output directory (with forward slashes). Whitespace is not supported.\n\nMakes 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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftranspect%2Ftranspectdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftranspect%2Ftranspectdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftranspect%2Ftranspectdoc/lists"}