From: Gustav Eek <gustav.eek@fripost.org>
Date: Mon, 25 Dec 2023 19:22:15 +0000 (+0100)
Subject: Doc. Update documentation for iCalendare RFC 5545 style
X-Git-Url: https://git.g-eek.se/?a=commitdiff_plain;ds=sidebyside;p=ranknauto.git

Doc. Update documentation for iCalendare RFC 5545 style
---

diff --git a/README b/README
index 5b75e94..484fd17 100644
--- a/README
+++ b/README
@@ -29,8 +29,8 @@ Write to the author in order to request binaries for your platform. No
 warranties of a response.
 
 
-Usage
-=====
+Usage and features
+==================
 
 Rank N' Auto, reads and writes on standard input and output. Some
 statistics parameters can be adjusted, see help for details:
@@ -43,15 +43,27 @@ echo -ne "Första post\nAndra\nTredje plats\nOch fjärde\n" \
     | ranknauto -s heavy
 ```
 
+Rank N' Auto is powerful in the sense that a wide range of output
+formatting is available. How you want the output is determined by the
+input formatting.
+
 Bullet lists, numbered item lists and piped tables are all respected.
+
 That means that bullets which are fed will remain in the output. The
 numbering is regenerated, starting from 1. List patterns are preserved
 at best effort, the widest input number is used for pattern
 definition, and output is adopted for right alignment. Piped tables
 are similarly regenerated.
 
+A-B-C-style priority notes such Org-mode's `[#A]` and the similar as
+`(A)` are updated. The interpretation is the 1--9 (high--low) plus 0
+(undefined) model described for the iCalender format, RFC 5545. For
+long lists all nine levels `A1`, `A2`, ..., `B1`, ... are provided.
+
 Also already ranked lists can be inserted; the previous ranking is
-ignored. Empty lines are ignored.
+replaced with the present ranking.
+
+Empty lines are ignored.
 
 Example:
 
@@ -74,6 +86,12 @@ cat <<EOF | ranknauto
  | 16 % | Tredje plats |
  | 27 % | Andra        |
 EOF
+cat <<EOF | ranknauto
+ * (C) Tredje plats
+ * (C) Och fjärde
+ * (A) Första post
+ * (B) Andra
+EOF
 ```
 
 Copying