Skip to content

Commit

Permalink
Proofread documentation (#594)
Browse files Browse the repository at this point in the history
  • Loading branch information
ggrossetie authored Aug 21, 2022
1 parent 36790de commit cfc72af
Show file tree
Hide file tree
Showing 9 changed files with 19 additions and 19 deletions.
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

The Asciidoctor Maven Plugin is the official way to convert your {uri-asciidoc}[AsciiDoc] documentation using {uri-asciidoctor}[Asciidoctor] from an {uri-maven}[Apache Maven] build.

The project main goal is to offer a thin layer on top of https://github.com/asciidoctor/asciidoctorj[Asciidoctorj] following as much as possible to common Maven practices.
The project main goal is to offer a thin layer on top of https://github.com/asciidoctor/asciidoctorj[AsciidoctorJ] following as much as possible to common Maven practices.

The conversion can happen in 2 flavors:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/plugin/pages/compatibility-matrix.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Compatibility Matrix

Here is the list of supported versions alongside the required {uri-asciidoctorj}[Asciidoctorj] version.
Here is the list of supported versions alongside the required {uri-asciidoctorj}[AsciidoctorJ] version.
Release candidate releases are not accounted.

== Versions
Expand Down
4 changes: 2 additions & 2 deletions docs/modules/plugin/pages/goals/auto-refresh.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Converts documents on change, that is, when one of them is modified, or a new one is added.

This plugin goal is aimed to help writing by removing the need for full rebuild to validate changes.
When the output is HTML, you can combine it with a refresh browser extension or use the xref:goals/http.adoc[http goal] to preview document changes while editing.
When the output is HTML, you can combine it with a refresh browser extension or use the xref:goals/http.adoc[`http` goal] to preview document changes while editing.

== Setup

Expand All @@ -32,7 +32,7 @@ include::partial$basic-maven-setup.adoc[]
<3> The Asciidoctor Maven plugin auto-refresh goal.

Once started, this will keep the maven process running until you type the `exit` or `quit` command in the console.
Or it is manually killed with _ctrl+c_.
Or it is manually killed with kbd:[Ctrl+C].

// TODO add animated gif showing this

Expand Down
8 changes: 4 additions & 4 deletions docs/modules/plugin/pages/goals/http.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
= http: HTML live preview
:navtitle: http

Converts AsciiDoc documents and starts an embedded http server to access content from the generated output directory.
Converts AsciiDoc documents and starts an embedded HTTP server to access content from the generated output directory.

Modified sources will be updated on change similarly to how the xref:goals/auto-refresh.adoc[auto-refresh goal] works.
While at the same time, HTML contents will be automatically refreshed on the web browser without need for manual steps.
Just open the file through the provided url that will appear in the console and write.
Just open the file through the provided URL that will appear in the console and write.

IMPORTANT: While the `http` goal can be used to serve any kind of content (e.g. PDF).
The possibilities have not been explored and are not officially supported, but feedback is welcome if you want to share your experience and ideas.

== Setup

The file extension is not necessary for html files in the url.
The file extension is not necessary for html files in the URL.
For example, the document _manual.html_ placed in the root path will be accessible as simply _pass:c[http://localhost:2000/manual]_.

include::partial$basic-maven-setup.adoc[]
Expand Down Expand Up @@ -45,7 +45,7 @@ Here we change the port to 8080.

This goal shares the following features (and limitations) with xref:goals/auto-refresh.adoc[auto-refresh].

* Once started, the maven process will keep running until explicitly stopped (`exit`, `quit` commands or _ctrl+c_).
* Once started, the maven process will keep running until explicitly stopped (`exit`, `quit` commands or kbd:[Ctrl+C]).
* Deleted or moved files will remain the in output directory until a clean is run.
* To take full advantage of all configuration options, the goal must be explicitly configured in the _pom.xml_ (see xref:goals/auto-refresh.adoc#auto-refresh-goal-config-note[setup note]).
* When a `failIf` condition occurs the goal will fail to complete and the server won't start.
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/plugin/pages/introduction.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Introduction

The Asciidoctor Maven Plugin is used to convert AsciiDoc documents using https://asciidoctor.org[Asciidoctor].
The plugin offers a comprehensive way to configure a conversion process using {uri-asciidoctorj}[Asciidoctorj] in a declarative way.
The plugin offers a comprehensive way to configure a conversion process using {uri-asciidoctorj}[AsciidoctorJ] in a declarative way.

== Goals overview

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/plugin/pages/tips-and-tricks.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
== Fail on missing attributes

Attributes whose value cannot be resolved are ignored by default and not shown as error or warning.
If you need to, this behaviour can be modified using the https://asciidoctor.org/docs/user-manual/#missing-attribute[missing-attribute] attribute.
If you need to, this behavior can be modified using the https://asciidoctor.org/docs/user-manual/#missing-attribute[missing-attribute] attribute.

Combining it with logHandler option it is possible to report an error and abort a build in case of missing attributes.

Expand Down
12 changes: 6 additions & 6 deletions docs/modules/plugin/pages/v2-migration-guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ This simplifies the plugin's code and projects' configuration avoiding ambiguiti
=== Removal of support for Java 7

From v2.x.x Java 8 will be the minimum required version.
If you are forced to use Java 7, we recommend using the version 1.5.8 with Asciidoctorj 1.6.2 for the most up to date features.
If you are forced to use Java 7, we recommend using the version 1.5.8 with AsciidoctorJ 1.6.2 for the most up to date features.

=== Removal of `imagesDir` configuration and change of its default value

Expand Down Expand Up @@ -60,7 +60,7 @@ If you are relying on the default value, make sure to add the attribute as in th

To avoid ambiguity between the configuration and attributes section, and make configuration more clear.

*The configuration option `sourceHighlighter` has been removed in favour of setting it as an attribute.*
*The configuration option `sourceHighlighter` has been removed in favor of setting it as an attribute.*
If you are using it, you will need to set it as follows:

[source,xml]
Expand All @@ -78,7 +78,7 @@ If you are using it, you will need to set it as follows:

Related discussion: https://github.com/asciidoctor/asciidoctor-maven-plugin/issues/417

These options serve to modify behaviours related with attributes.
These options serve to modify behaviors related with attributes.
From showing console warning messages, to removing lines of text amongst others.

*If you are currently using these options, you will need to add them to the attributes section.*
Expand All @@ -99,7 +99,7 @@ From showing console warning messages, to removing lines of text amongst others.

Related discussion: https://github.com/asciidoctor/asciidoctor-maven-plugin/issues/265

As stated in https://asciidoctor.org/docs/user-manual/#ruby-api-options `template_dir` option is deprecated in favour of `template_dirs`.
As stated in https://asciidoctor.org/docs/user-manual/#ruby-api-options `template_dir` option is deprecated in favor of `template_dirs`.
Following this change the plugin configuration `<templateDir>` will be replaced by `templateDirs`.
This will allow the use of multiple template directories.

Expand Down Expand Up @@ -131,7 +131,7 @@ Nowadays the main usage is HTML conversion, so it makes sense to set `html5` as
This should reduce configuration for most users.

*If you are converting to HTML, you won't need to set the `<backend>` element.
If you are converting to Docbook, you will need to set it explicitly as follows.*
If you are converting to DocBook, you will need to set it explicitly as follows.*

[source,xml]
.backward compatible configuration
Expand All @@ -156,7 +156,7 @@ If the path does not exist, `src/asciidoc` and `src/main/asciidoc` are searched

*This change does not break compatibility* and has the advantage of following the same pattern as the https://github.com/asciidoctor/asciidoctor-gradle-plugin[asciidoctor-gradle-plugin], making easier to test both plugins.

== Asciidoctorj changes
== AsciidoctorJ changes

Not part of the asciidoctor-maven-plugin, but important to consider during upgrade, the https://github.com/asciidoctor/asciidoctorj/tree/v2.0.0-RC.1#extension-api[AsciidocotorJ extension API] has suffered modifications.

Expand Down
4 changes: 2 additions & 2 deletions docs/modules/plugin/partials/basic-maven-setup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@ As this is a typical Maven plugin, simply declare the plugin in the `<plugins>`
</plugin>
</plugins>
----
<1> The plugin will use the latest Asciidoctorj version available at release.
To change it, set the desired version as a plugin dependency.
<1> The plugin will use the latest AsciidoctorJ version available at release.
To change it, set the desired version as a plugin dependency.
2 changes: 1 addition & 1 deletion docs/modules/project/pages/contributing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The requirements are very small:

Everything else will be brought in by Maven.
This is a typical Maven Java project, nothing special.
You should be able to use IntelliJ, Eclipse, or Netbeans without any issue for hacking on the project.
You should be able to use IntelliJ, Eclipse, or NetBeans without any issue for hacking on the project.

== Testing

Expand Down

0 comments on commit cfc72af

Please sign in to comment.