aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2016-08-29 11:40:09 +0100
committerMichael Williamson <mike@zwobble.org>2016-08-29 11:40:09 +0100
commit2384712fd99af6d7fd8b172cf29b699583bf26f8 (patch)
treeeeb1ca373185b2c4d1acd6c907681bb7ed7a6a52 /README.md
parent955a29e828d40123ec64a479b1c4c5164db3c681 (diff)
Add documentation for comments
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index fdf9c17..50c2dbb 100644
--- a/README.md
+++ b/README.md
@@ -39,6 +39,8 @@ The following features are currently supported:
* Text boxes. The contents of the text box are treated as a separate paragraph
that appears after the paragraph containing the text box.
+* Comments.
+
## Installation
Available on [Maven Central](http://search.maven.org/#artifactdetails|org.zwobble.mammoth|mammoth|0.0.3|jar).
@@ -178,6 +180,22 @@ For instance, to wrap strikethrough text in `<del>` tags:
DocumentConverter converter = new DocumentConverter()
.addStyleMap("strike => del");
```
+
+#### Comments
+
+By default, comments are ignored.
+To include comments in the generated HTML,
+add a style mapping for `comment-reference`.
+For instance:
+
+```java
+DocumentConverter converter = new DocumentConverter()
+ .addStyleMap("comment-reference => sup");
+```
+
+Comments will be appended to the end of the document,
+with links to the comments wrapped using the specified style mapping.
+
### API
#### `DocumentConverter`