diff options
author | Nicolas Goaziou <mail@nicolasgoaziou.fr> | 2018-12-18 11:08:48 +0100 |
---|---|---|
committer | Nicolas Goaziou <mail@nicolasgoaziou.fr> | 2018-12-18 11:08:48 +0100 |
commit | 4f0d8a008f866d8da131a5e2a1db3e73134cfe56 (patch) | |
tree | 17bd447f53fa5045f7cd1df549f6f70ddbd7c5d1 | |
parent | 13f299fe8baf389374127572ee56a31910b36f2e (diff) | |
download | org-mode-4f0d8a008f866d8da131a5e2a1db3e73134cfe56.tar.gz |
org-colview: Improve docstring
* lisp/org-colview.el (org-dblock-write:columnview): Improve docstring.
-rw-r--r-- | lisp/org-colview.el | 62 |
1 files changed, 46 insertions, 16 deletions
diff --git a/lisp/org-colview.el b/lisp/org-colview.el index a2d482b..41abd5f 100644 --- a/lisp/org-colview.el +++ b/lisp/org-colview.el @@ -1390,24 +1390,54 @@ an inline src-block." ;;;###autoload (defun org-dblock-write:columnview (params) "Write the column view table. + PARAMS is a property list of parameters: -:id the :ID: property of the entry where the columns view - should be built. When the symbol `local', call locally. - When `global' call column view with the cursor at the beginning - of the buffer (usually this means that the whole buffer switches - to column view). When \"file:path/to/file.org\", invoke column - view at the start of that file. Otherwise, the ID is located - using `org-id-find'. -:hlines When t, insert a hline before each item. When a number, insert - a hline before each level <= that number. -:indent When non-nil, indent each ITEM field according to its level. -:vlines When t, make each column a colgroup to enforce vertical lines. -:maxlevel When set to a number, don't capture headlines below this level. -:match When set to a string, use this as a tags/property match filter. -:skip-empty-rows - When t, skip rows where all specifiers other than ITEM are empty. -:format When non-nil, specify the column view format to use." +`:id' (mandatory) + + The ID property of the entry where the columns view should be + built. When the symbol `local', call locally. When `global' + call column view with the cursor at the beginning of the + buffer (usually this means that the whole buffer switches to + column view). When \"file:path/to/file.org\", invoke column + view at the start of that file. Otherwise, the ID is located + using `org-id-find'. + +`:exclude-tags' + + List of tags to exclude from column view table. + +`:format' + + When non-nil, specify the column view format to use. + +`:hlines' + + When non-nil, insert a hline before each item. When + a number, insert a hline before each level inferior or equal + to that number. + +`:indent' + + When non-nil, indent each ITEM field according to its level. + +`:match' + + When set to a string, use this as a tags/property match filter. + +`:maxlevel' + + When set to a number, don't capture headlines below this level. + +`:skip-empty-rows' + + When non-nil, skip rows where all specifiers other than ITEM + are empty. + +`:vlines' + + When non-nil, make each column a column group to enforce + vertical lines." (let ((table (let ((id (plist-get params :id)) view-file view-pos) |