[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/orgalist 5659da7 5/7: orgalist: Improve documentation
From: |
Nicolas Goaziou |
Subject: |
[elpa] externals/orgalist 5659da7 5/7: orgalist: Improve documentation |
Date: |
Tue, 1 May 2018 09:31:00 -0400 (EDT) |
branch: externals/orgalist
commit 5659da7e33192f36608d45129bd5d4882d0237fe
Author: Nicolas Goaziou <address@hidden>
Commit: Nicolas Goaziou <address@hidden>
orgalist: Improve documentation
---
orgalist.el | 31 ++++++++++++++++++++++++++++---
1 file changed, 28 insertions(+), 3 deletions(-)
diff --git a/orgalist.el b/orgalist.el
index ac05480..a9ec2800 100644
--- a/orgalist.el
+++ b/orgalist.el
@@ -27,9 +27,34 @@
;; a minor mode.
;; More specifically, it supports syntax for numbered, unnumbered,
-;; description items, checkboxes, and counter cookies. See (info
-;; "(org) Plain Lists") and (info "(org) Checkboxes") for details
-;; about the syntax of such constructs.
+;; description items, checkboxes, and counter cookies. Examples of
+;; such constructs include:
+
+;; - item 1
+;; - item 2
+;; - [ ] checbox sub-item
+
+;; or
+
+;; 1. item 1
+;; 2. item 2
+;; 1. sub-item 1
+;; 8. address@hidden sub-item 8
+
+;; and
+
+;; - term :: definition
+;; - term 2 :: definition 2
+
+;; To start a list, type `- <SPC>' or `1 . <SPC>', then write the
+;; contents of the item. To create a new item, use `M-<RET>'. If it
+;; should be a child of the previous item, use `<TAB>' or `M-<RIGHT>'.
+;; For example, `- <SPC> i t e m M-<RET> <TAB> c h i l d' produces:
+;; - item
+;; - child
+
+;; See (info "(org) Plain Lists") and (info "(org) Checkboxes") for
+;; more details about the syntax of such constructs.
;; The following features are supported:
- [elpa] externals/orgalist updated (17653db -> 857d3d5), Nicolas Goaziou, 2018/05/01
- [elpa] externals/orgalist 857d3d5 7/7: orgalist: Bump to version 1.2, Nicolas Goaziou, 2018/05/01
- [elpa] externals/orgalist 93609f9 2/7: orgalist: Simplify auto fill, Nicolas Goaziou, 2018/05/01
- [elpa] externals/orgalist 34d6322 4/7: orgalist: Replace `orgalist--indentation' with `current-indentation', Nicolas Goaziou, 2018/05/01
- [elpa] externals/orgalist 8ac38b2 6/7: orgalist: Add non-nil `sentence-end-double-space' file local variable, Nicolas Goaziou, 2018/05/01
- [elpa] externals/orgalist 63e90b5 1/7: orgalist: Fix filling items, Nicolas Goaziou, 2018/05/01
- [elpa] externals/orgalist 470ab82 3/7: orgalist: Improve indentation cycling, Nicolas Goaziou, 2018/05/01
- [elpa] externals/orgalist 5659da7 5/7: orgalist: Improve documentation,
Nicolas Goaziou <=