asciidoctor-rhrev 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7a1ad3cb27fbce5f7a4295c90d2f069407d993230f89e14d6d05e4f34f3d6302
+  data.tar.gz: 9129908c97d9da8ad0b16028e92e722103db4a865504e357c1c28748eadadbc0
+SHA512:
+  metadata.gz: 95a202f0e4560c9ce5eb51de3bd53325c44ae41d820c40db2b791ed6438f797f121cc143559ee3ab564b88006156e4724ad6730d9680a95cee464f24885280d6
+  data.tar.gz: d47b9bf8163523403bf7a41a2c52765eaafcf33b41e33a7737a2801234382b80e13ec9c646ea35dc6ce05bddd3b5afe4cd900a96e50d0d7f8bb13500bd178823

data/LICENSE

@@ -0,0 +1,25 @@
+MIT License
+
+
+This project includes code from Asciidoctor PDF by OpenDevise Inc. and the Asciidoctor Project,
+licensed under the MIT License:
+
+Copyright (c) 2025 白一百 baiyibai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.adoc

@@ -0,0 +1,136 @@
+= rhrev - Asciidoctor PDF Revision History Extension
+
+rhrev is a comprehensive revision history tracking system for the AsciiDoc and Antora ecosystems which automatically creates a grouped, formatted table of document changes.
+
+It supports several converters/backends:
+
+* asciidoctor-pdf
++
+image::resources/ruby-pdf-output.png[width=50%]
++
+xref:./tests/block/test-block-ordering-comprehensive.pdf[Comprehensive Block Ordering Test]
+* asciidoctor
++
+image::resources/ruby-html5-output.png[width=50%]
++
+* Antora
++
+image::resources/nodejs-html5-output.png[width=50%]
++
+* Antora-Assembler to asciidoctor-pdf
+
+== Features
+
+* *Automatic revision tracking* with version-based grouping
+* *Dynamic version labels* using `:version-label:` attribute
+* *Localization support* for multiple languages
+* *Export to AsciiDoc* for inclusion in other documents
+* *Flexible placement* (auto or manual via macro)
+* *Extensive customization* options for styling and formatting
+* [PDF] *Clickable page references* that link to actual document locations  
+* [PDF] *Flexible xrefstyle support* (full, short, basic) for all block types
+* [PDF] *Custom captions* for Examples, Tables, Listings, and Figures
+* *FAST*
+
+== Inspiration
+
+This extension draws inspiration from:
+
+* **DITA-like automatic revision histories** - Darwin Information Typing Architecture (DITA) provides automatic change tracking and revision metadata management in technical documentation systems
+* **LaTeX revision tracking tools** - LaTeX packages like `changes`, `trackchanges`, and custom revision history macros that automate change documentation in academic and technical publications
+* **Document management systems** - Enterprise documentation platforms that maintain automatic audit trails and change histories
+
+The goal was to bring similar automated revision tracking capabilities to the Asciidoctor ecosystem, with the added benefit of clickable page references and flexible customization options tailored for PDF technical documentation.
+
+== Quick Start
+
+=== Installation
+
+The asciidoctor-pdf-rhrev extension is available as a Ruby Gem.
+
+https://rubygems.org/gems/asciidoctor-pdf-rhrev[^]
+
+Complete these steps to use:
+
+. Install the required Gems:
++
+[source,bash]
+----
+gem install asciidoctor
+gem install asciidoctor-pdf
+gem install asciidoctor-pdf-rhrev
+----
++
+. Render your document:
++
+[source,bash]
+----
+asciidoctor-pdf -r asciidoctor-pdf-rhrev document.adoc
+----
+
+=== Basic Usage
+
+[source,asciidoc]
+----
+= My Document
+:doctype: book
+:revnumber: 1.1
+:rhrev:
+:version-label: Version
+// 1.0 Metadata
+:1-1-prevrev: 1.0
+:1-1-prevrevdate: 2024-02-01
+:rhrev1-1-all: Feature update
+
+[rhrev1-1="Updated introduction"]
+== Introduction
+
+Content here...
+----
+
+== Documentation
+
+See link:USAGE.adoc[] for complete documentation including:
+
+* Configuration options
+* Advanced features
+* Localization
+* Export functionality
+* xrefstyle support
+* Examples and use cases
+
+== Testing
+
+Run the test suite:
+
+[source,bash]
+----
+./run-tests.sh
+----
+
+This will generate PDFs for all test cases in the `tests/` directory.
+
+=== Ruby GEM Build Instructions (for 白一百 baiyibai)
+
+[source,bash]
+----
+gem build asciidoctor-pdf-rhrev.gemspec 
+gem install ./asciidoctor-pdf-rhrev-1.0.0.gem
+----
+
+== License
+
+MIT License. See the link:LICENSE[] file for details.
+
+== Contributing
+
+Contributions welcome! Please ensure all tests pass before submitting changes.
+
+== Copyright
+
+Copyright (C) 2025-present 白一百 baiyibai 
+
+* The image _The «Public Domain Mark» icon from Creative Commons with transparent background._ is in the public domain and taken from: +
+https://commons.wikimedia.org/wiki/File:Cc-public_domain_mark.svg[^]
+
+For the full text of the license, see the link:LICENSE[] file.