{"id":23282787,"url":"https://github.com/itsallcode/openfasttrace-asciidoc-plugin","last_synced_at":"2025-07-23T15:40:52.717Z","repository":{"id":249376570,"uuid":"831321711","full_name":"itsallcode/openfasttrace-asciidoc-plugin","owner":"itsallcode","description":"AsciiDoc-importer for OpenFastTrace","archived":false,"fork":false,"pushed_at":"2024-08-11T08:04:33.000Z","size":58,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-12-20T00:31:26.786Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/itsallcode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","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":"2024-07-20T08:05:11.000Z","updated_at":"2024-08-17T05:40:59.000Z","dependencies_parsed_at":"2024-12-20T00:39:56.566Z","dependency_job_id":null,"html_url":"https://github.com/itsallcode/openfasttrace-asciidoc-plugin","commit_stats":null,"previous_names":["itsallcode/openfasttrace-asciidoc-plugin"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsallcode%2Fopenfasttrace-asciidoc-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsallcode%2Fopenfasttrace-asciidoc-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsallcode%2Fopenfasttrace-asciidoc-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itsallcode%2Fopenfasttrace-asciidoc-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/itsallcode","download_url":"https://codeload.github.com/itsallcode/openfasttrace-asciidoc-plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238545169,"owners_count":19490034,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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-12-20T00:29:49.177Z","updated_at":"2025-02-12T20:27:59.656Z","avatar_url":"https://github.com/itsallcode.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# \u003cimg src=\"doc/openfasttrace_logo.svg\" alt=\"OFT logo\" width=\"150\"/\u003e OpenFastTrace AsciiDoc Plugin\n\n## What is OpenFastTrace AsciiDoc Plugin?\n\nThis plugin allows OpenFastTrace (OFT) to parse and trace requirements in AsciiDoc files. Requirement tracing keeps track of whether you implemented everything you planned to in your specifications. It also identifies obsolete parts of your product and helps you to get rid of them.\n\nFor more details about requirement tracing and how to use OpenFastTrace, refer to the [user guide](doc/user_guide.md).\n\n_[Place a screenshot of a tracing report generated using this plugin here]_\n\n## Project Information\n\n[![Build](https://github.com/itsallcode/openfasttrace-asciidoc-plugin/actions/workflows/build.yml/badge.svg)](https://github.com/itsallcode/openfasttrace-asciidoc-plugin/actions/workflows/build.yml)\n[![Maven Central Version](https://img.shields.io/maven-central/v/org.itsallcode/openfasttrace-asciidoc-plugin)](https://search.maven.org/artifact/org.itsallcode/openfasttrace-asciidoc-plugin)\n\nSonarcloud status:\n\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace-asciidoc-plugin\u0026metric=alert_status)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aopenfasttrace-asciidoc-plugin)\n[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace-asciidoc-plugin\u0026metric=bugs)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aopenfasttrace-asciidoc-plugin)\n[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace-asciidoc-plugin\u0026metric=code_smells)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aopenfasttrace-asciidoc-plugin)\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace-asciidoc-plugin\u0026metric=coverage)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aopenfasttrace-asciidoc-plugin)\n[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace-asciidoc-plugin\u0026metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aopenfasttrace-asciidoc-plugin)\n[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace-asciidoc-plugin\u0026metric=ncloc)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aopenfasttrace-asciidoc-plugin)\n[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace-asciidoc-plugin\u0026metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aopenfasttrace-asciidoc-plugin)\n[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace-asciidoc-plugin\u0026metric=security_rating)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aopenfasttrace-asciidoc-plugin)\n[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace-asciidoc-plugin\u0026metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aopenfasttrace-asciidoc-plugin)\n[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace-asciidoc-plugin\u0026metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aopenfasttrace-asciidoc-plugin)\n[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace-asciidoc-plugin\u0026metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aopenfasttrace-asciidoc-plugin)\n\n## What is AsciiDoc?\n\n[AsciiDoc](https://asciidoc.org/) is a human-readable document format, semantically equivalent to DocBook XML, but using plain-text mark-up conventions. AsciiDoc documents can be created using any text editor and can be viewed and edited in source form without requiring additional tools.\n\nAsciiDoc is highly configurable: both the AsciiDoc source file syntax and the backend output markups (which can be almost any type of SGML/XML markup) can be customized and extended by the user.\n\n## How does AsciiDoc fit into OFT?\n\nIn the context of OpenFastTrace (OFT), AsciiDoc files can be used to write the software requirements specification. The AsciiDoc format allows for requirement IDs to be embedded in the text, which can then be traced by OFT.\n\nUsing the AsciiDoc Plugin, OFT is able to read and parse AsciiDoc files, trace the requirements mentioned in the files, and generate a requirement tracing report. This allows for easy tracking of the implementation status of each requirement directly from the specification document.\n\n**User Guides**\n\n* [📖 User Guide](doc/user_guide.md)\n\n**News and Discussions**\n\n* [📢 Blog](https://blog.itsallcode.org/)\n* [🗨️ Discussion Board](https://github.com/itsallcode/openfasttrace/discussions)\n\n**Information for Contributors**\n\n* [🎟️ Project Board](https://github.com/orgs/itsallcode/projects/3/views/1)\n* [🦮 Developer Guide](doc/developer_guide.md)\n* [🎁 Contributing Guide](CONTRIBUTING.md)\n\n## Using OpenFastTrace AsciiDoc Plugin\n\nThe plugin can be used with the standard OFT command line, integrated into Maven or Gradle build cycles, or applied through a continuous integration pipeline.\n\nFor more detailed information on how to use OpenFastTrack with AsciiDoc Plugin, consult our [user guide](doc/user_guide.md).\n\n## Getting OpenFastTrace AsciiDoc Plugin\n\nThe OpenFastTrace AsciiDoc Plugin is supplied as a Java Archive (JAR) which can be obtained from:\n\n* [Maven Central](#)\n* [GitHub](https://github.com/itsallcode/openfasttrace-asciidoc-plugin/releases)\n\nMore details about adding the plugin to an existing establishment are outlined in the [developer guide](doc/developer_guide.md).\n\n## Installation\n\n### Runtime Dependencies\n\nOpenFastTrace AsciiDoc Plugin needs a Java 17 (or later) runtime environment to run properly.\n\n#### Installation of Runtime Dependencies on Linux\n\n##### Ubuntu or Debian\n\nTo install Java Runtime Environment:\n\n    apt-get install openjdk-17-jre\n\n## Running OpenFastTrace With the AsciiDoc Plugin\n\nTo run OFT with the plugin, you can add the plugin to the Java classpath or one of OFT's plugin search directories.\n\nFor more details, please check out the OFT user guide's chapter on plugins.\n\n\u003c!-- TODO: add link --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitsallcode%2Fopenfasttrace-asciidoc-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fitsallcode%2Fopenfasttrace-asciidoc-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitsallcode%2Fopenfasttrace-asciidoc-plugin/lists"}