Skip to content

Commit 02a72d0

Browse files
committed
Grammar and spelling corrections.
1 parent 2c80601 commit 02a72d0

File tree

2 files changed

+13
-12
lines changed

2 files changed

+13
-12
lines changed

CHANGELOG.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Record of bug fixes, enhancements, and changes.
1515
## [1.1.3] – 2022-07-07-16
1616

1717
### Fixed
18-
- The global and case-insensitive flags (ig) are now parsing correctly: using ii or gg will cause prevent the callout block from being processed. Thanks to Hakim Cassimally for finding the bug.
18+
- The global and case-insensitive flags (ig) are now parsing correctly: using ii or gg prevented the callout block from being processed. Thanks to Hakim Cassimally for finding the bug.
1919
- Escaped slash characters were not being processed in the search. Thanks to Hakim Cassimally for finding the bug.
2020

2121
## [1.1.2] – 2022-07-07
@@ -43,7 +43,7 @@ Record of bug fixes, enhancements, and changes.
4343

4444
### Changed
4545

46-
- Ordered lists were only processes if they occurred directly beneath a source listing block. This turns out to be quite restrictive, and doesn't follow Asciidoc's stance on processing standard callouts, which allows for intermediate blocks to separate the source list from the attached callout list.\
46+
- Ordered lists were only processes if they occurred directly beneath a source listing block. This turns out to be quite restrictive and doesn't follow Asciidoc's stance on processing standard callouts, which allows for intermediate blocks to separate the source list from the attached callout list.\
4747
The processor will now allow intermediate blocks to separate the source listing from the ordered list containing callouts.
48-
- Fixed a few spelling mistakes and a code line where I was picking up a formatted item, rather than a raw item.
48+
- Fixed a few spelling mistakes and a code line where I was picking up a formatted item, rather than a raw item.
4949

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ An [Asciidoctor](https://asciidoctor.org/) extension which adds support for call
66

77
## Motivation
88

9-
Aside from getting little practice around Ruby and JavaScript, I decided to have a crack at this to help with a problem that comes up at work every so often.
9+
Aside from getting little practice around Ruby and JavaScript, I decided to have a crack at this to help with a problem that comes up at work every so often.
1010

1111
The [callout mechanism](https://docs.asciidoctor.org/asciidoc/latest/verbatim/callouts/) for Asciidoc works extremely well in 99% of the cases I run into:
1212

@@ -48,7 +48,7 @@ end
4848
. Response block @5
4949
```
5050

51-
Rather than tagging the code, you add a location token at the end of a list item, which will then add the tag at the specified line number. Run the source text through Asciidoctor+extension, and it'll spit the same source block complete with callouts.
51+
Rather than tagging the code, you add a location token at the end of a list item, which will then add the tag at the specified line number. Run the source text through Asciidoctor+extension, and it'll split the same source block complete with callouts.
5252

5353
Two types of location token are supported:
5454

@@ -57,7 +57,7 @@ Two types of location token are supported:
5757

5858
**@/_text_/**
5959
: The text between the two slashes will be used in a regex search. A callout will be placed at the end of the first matching line.
60-
If you have a large listing then it may be preferable to use the text search rather than counting all the lines. It may also be preferable to use a smaller listing, as a long listing might mean that your description is a bit too general. +
60+
If you have a large listing, then it may be preferable to use the text search rather than counting all the lines. It may also be preferable to use a smaller listing, as a long listing might mean that your description is a bit too general. +
6161
Using the text search method means that the location of the callout will move with the line; handy if you're referencing a source file that might get the occasional tweak outside your control.
6262

6363
**@/_text_/g**
@@ -70,7 +70,8 @@ Using the text search method means that the location of the callout will move wi
7070
: And of course, you can combine the two, though I'm not sure why you'd want to.
7171

7272
## Standalone callout lists
73-
You can create a standalone callout list by adding the `calloutlist` role to an ordered list. This simply styles the list to make it look like a list of callouts so you can use it as a reference to annoted images etc.
73+
You can create a standalone callout list by adding the `calloutlist` role to an ordered list.
74+
This simply styles the list to make it look like a list of callouts, so you can use it as a reference to annoted images etc.
7475
```asciidoc
7576
[calloutlist]
7677
. This list can be used to add references to annotated images
@@ -104,10 +105,10 @@ require 'asciidoctor'
104105
Asciidoctor.convert_file File.join(File.dirname(__FILE__), 'sample.adoc'), safe: :unsafe, backend: :html5
105106
```
106107

107-
## Use with the [IntelliJ Asciidoc Plugin](https://plugins.jetbrains.com/plugin/7391-asciidoc)
108+
## Use the [IntelliJ Asciidoc Plugin](https://plugins.jetbrains.com/plugin/7391-asciidoc)
108109

109-
If you're not using the excellent Asciidoc plugin then you're really missing out.
110-
One if its lesser known features is that it supports Asciidoc extensions written in Ruby:
110+
If you're not using the excellent Asciidoc plugin, then you're really missing out.
111+
One of its lesser known features is that it supports Asciidoc extensions written in Ruby:
111112

112113
1. Create a new folder structure in the root of your IntelliJ project called `.asciidoctor/lib`.
113114
2. Copy the file `asciidoctor-external-calllout.rb` from this distribution to `.asciidoctor/lib`.
@@ -128,7 +129,7 @@ The callout attaches a class called `external-callout-block` to each source list
128129

129130
The extension also adds a class called `external-callout-list` to the list of definitions at the bottom of the source block. (There's probably no need to adjust the styling for this.)
130131

131-
Then to convert a document with a stylesheet, use something like this:
132+
To convert a document with a stylesheet, use something like this:
132133

133134
```ruby
134135
Asciidoctor.convert_file File.join(File.dirname(__FILE__), 'sample.adoc'),
@@ -144,7 +145,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
144145

145146
## License
146147

147-
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
148+
The gem is open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
148149

149150
## Code of Conduct
150151

0 commit comments

Comments
 (0)