aboutsummaryrefslogtreecommitdiff
path: root/core/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'core/README.md')
-rw-r--r--core/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/core/README.md b/core/README.md
index c26836e..b952797 100644
--- a/core/README.md
+++ b/core/README.md
@@ -6,6 +6,7 @@
* [KPrefs](#kprefs)
* [Changelog XML](#changelog)
+* [FAQ XML](#faq-xml)
* [Kotterknife](#kotterknife)
* [Ripple Canvas](#ripple-canvas)
* [MeasureSpecDelegate](#measure-spec-delegate)
@@ -106,6 +107,20 @@ Here is a template xml changelog file:
</resources>
```
+<a name="faq-xml"></a>
+## FAQ XML
+
+There is another parser for a FAQ list with the following format:
+
+```xml
+<question>This is a question</question>
+<answer>This is an answer</answer>
+```
+
+Calling `kauParseFaq` will give you a `List<Pair<Spanned, Spanned>` that you can work with.
+By default, the questions are numbered, and the content is formatted with HTML.
+You may still need to add your own methods to allow interaction with certain elements such as links.
+
<a name="kotterknife"></a>
## Kotterknife