diff options
| author | Dan Allen <dan.j.allen@gmail.com> | 2014-08-17 23:47:17 -0600 |
|---|---|---|
| committer | Dan Allen <dan.j.allen@gmail.com> | 2014-08-17 23:47:17 -0600 |
| commit | cb60065473fc4ffea033f067ae98f64d61d345dc (patch) | |
| tree | c25501089420fbaecea2d55b77da53bbeba42521 /README.adoc | |
| parent | 36bf51b1291661d471716c81a4ae1ad8235d38c9 (diff) | |
change terminology to "convert"; switch to uri-* attribute name prefix
Diffstat (limited to 'README.adoc')
| -rw-r--r-- | README.adoc | 55 |
1 files changed, 28 insertions, 27 deletions
diff --git a/README.adoc b/README.adoc index 9c8510d1..fc355783 100644 --- a/README.adoc +++ b/README.adoc @@ -1,24 +1,24 @@ -= Asciidoctor PDF: A native PDF renderer for AsciiDoc -OpenDevise Inc. += Asciidoctor PDF: A _native_ PDF converter for AsciiDoc +Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Sarah White <https://github.com/graphitefriction[@graphitefriction]> // Settings: :experimental: // Aliases: :project-name: Asciidoctor PDF -// URIs: :project-handle: asciidoctor-pdf -:project-uri: https://github.com/asciidoctor/asciidoctor-pdf -:project-repo-uri: https://github.com/asciidoctor/asciidoctor-pdf -:project-issues-uri: {project-repo-uri}/issues -:prawn-uri: http://prawn.majesticseacreature.com -:rvm-uri: http://rvm.io -:asciidoctor-uri: http://asciidoctor.org -:base-repo-uri: {project-repo-uri}/blob/master/ -ifdef::env-github[:base-repo-uri: link:] -:notice-uri: {base-repo-uri}NOTICE.adoc -:license-uri: {base-repo-uri}LICENSE.adoc -:worklog-uri: {base-repo-uri}WORKLOG.adoc - -_Lo and behold_, a native PDF renderer for AsciiDoc built with {asciidoctor-uri}[Asciidoctor] and {prawn-uri}[Prawn]! + +// URIs: +:uri-project: https://github.com/asciidoctor/asciidoctor-pdf +:uri-project-repo: https://github.com/asciidoctor/asciidoctor-pdf +:uri-project-issues: {uri-project-repo}/issues +:uri-prawn: http://prawn.majesticseacreature.com +:uri-rvm: http://rvm.io +:uri-asciidoctor: http://asciidoctor.org +:repo-base-uri: {uri-project-repo}/blob/master/ +ifdef::env-github[:repo-base-uri: link:] +:uri-notice: {repo-base-uri}NOTICE.adoc +:uri-license: {repo-base-uri}LICENSE.adoc +:uri-worklog: {repo-base-uri}WORKLOG.adoc + +_Lo and behold_, a native PDF converter for AsciiDoc built with {uri-asciidoctor}[Asciidoctor] and {uri-prawn}[Prawn]! + _No more DocBook toolchain._ + _No more middleman._ + We're talking AsciiDoc direct to PDF! @@ -26,14 +26,15 @@ We're talking AsciiDoc direct to PDF! .Project status CAUTION: {project-name} is currently _alpha_ software. Use accordingly. -Though the bulk of AsciiDoc content is rendered, there's still work needed to fill in gaps where rendering is incomplete, incorrect or not implemented. +Though the bulk of AsciiDoc content is converter, there's still work needed to fill in gaps where conversion is incomplete, incorrect or not implemented. Once it's ready, the project will be moved into the Asciidoctor organization on GitHub. == Prawn, the majestic PDF generator -{project-uri}[{project-name}] is made possible by the amazing Prawn RubyGem. _What a gem it is!_ +{uri-project}[{project-name}] is made possible by the amazing Prawn RubyGem. +_What a gem it is!_ -{prawn-uri}[Prawn] is a nimble PDF writer for Ruby. +{uri-prawn}[Prawn] is a nimble PDF writer for Ruby. More important, it's a hackable platform that offers both high level APIs for the most common needs and low level APIs for bending the document model to accomodate special circumstances. With Prawn, you can write text, draw lines and shapes and place images _anywhere_ on the page and add as much color as you like. @@ -60,7 +61,7 @@ Picking up from there, {project-name} takes the pain out of creating printable d == Notable Features -* Direct AsciiDoc to PDF rendering +* Direct AsciiDoc to PDF conversion * Configuration-driven style and layout * PDF document outline (i.e., bookmarks) * Document metadata (title, authors, subject, keywords, etc) @@ -72,7 +73,7 @@ Picking up from there, {project-name} takes the pain out of creating printable d === Missing Features -See {worklog-uri}[WORKLOG]. +See {uri-worklog}[WORKLOG]. == Prerequisites @@ -82,7 +83,7 @@ To check you have Ruby available, use the +ruby+ command to query the version in $ ruby --version -If you're using {rvm-uri}[RVM], we recommend creating a new gemset to work with Asciidoctor and {project-name}: +If you're using {uri-rvm}[RVM], we recommend creating a new gemset to work with Asciidoctor and {project-name}: $ rvm use 2.1@asciidoctor-pdf --create @@ -101,7 +102,7 @@ You can retrieve the {project-name} project in one of two ways: ==== Option 1: Fetch using git clone -If you want to clone the git repository, simply copy the {project-repo-uri}[GitHub repository URL] and pass it to +git clone+ command: +If you want to clone the git repository, simply copy the {uri-project-repo}[GitHub repository URL] and pass it to +git clone+ command: $ git clone https://github.com/asciidoctor/asciidoctor-pdf @@ -192,7 +193,7 @@ Open that file with a PDF viewer to see the result. .Example PDF document rendered in a PDF viewer image::examples/example-pdf-screenshot.png[Screenshot of PDF document,width=800,scaledwidth=100%] -You're also encouraged to try rendering this link:README.adoc[README] as well as the documents in the examples directory to see more of what {project-name} can do. +You're also encouraged to try converting this link:README.adoc[README] as well as the documents in the examples directory to see more of what {project-name} can do. Another good example is the https://github.com/cdi-spec/cdi/tree/master/spec[CDI Specification]. The pain of the DocBook toolchain should be melting away about now. @@ -231,7 +232,7 @@ In the spirit of free software, _everyone_ is encouraged to help improve this pr To contribute code, simply fork the project on GitHub, hack away and send a pull request with your proposed changes. -Feel free to use the {project-issues-uri}[issue tracker] or http://discuss.asciidoctor.org[Asciidoctor mailing list] to provide feedback or suggestions in other ways. +Feel free to use the {uri-project-issues}[issue tracker] or http://discuss.asciidoctor.org[Asciidoctor mailing list] to provide feedback or suggestions in other ways. == Authors @@ -242,5 +243,5 @@ Feel free to use the {project-issues-uri}[issue tracker] or http://discuss.ascii Copyright (C) 2014 OpenDevise Inc. and the Asciidoctor Project. Free use of this software is granted under the terms of the MIT License. -For the full text of the license, see the {license-uri}[LICENSE.adoc] file. -Refer to the {notice-uri}[NOTICE.adoc] file for information about third-party Open Source software in use. +For the full text of the license, see the {uri-license}[LICENSE.adoc] file. +Refer to the {uri-notice}[NOTICE.adoc] file for information about third-party Open Source software in use. |
