From: Jorge Morais Neto <jorge13515@gmail.com>
To: org mode <emacs-orgmode@gnu.org>
Subject: Bug: second batch of small documentation problems [9.0 (9.0-elpaplus @ /home/jorge/.emacs.d/elpa/org-plus-contrib-20161102/)]
Date: Sun, 6 Nov 2016 10:55:52 -0200 [thread overview]
Message-ID: <CAJR3QnevNB+foybMsBUcVdr1KMbQkeEmj874o2VRTgqM0=b-zg@mail.gmail.com> (raw)
Finally the second batch I promised. Sorry for having taken this long.
- org-table-convert-region docstring is less complete than the manual\\
The docstring contains the line:
#+BEGIN_QUOTE
integer When a number, use that many spaces as field separator
#+END_QUOTE
[[info:org#Built-in table editor]] says:
#+BEGIN_QUOTE
a numeric argument N indicates that at least N consecutive spaces, or
alternatively a TAB will be the separator.
#+END_QUOTE
In the latter, notice the "or alternatively a TAB". I believe the docstring
should be complete, so please add this information.
- org-archive-to-archive-sibling ARCHIVE_TIME property\\
org-archive-to-archive-sibling adds an ARCHIVE_TIME property. This should be
documented in the docstring and probably also in the manual.
- [[info:org#The very busy C-c C-c key]]
#+BEGIN_QUOTE
− If the current buffer is a capture buffer, close the note and file it.
With a prefix argument, file it, without further interaction, to the
default location.
#+END_QUOTE
Actually, according to [[info:org#Using capture]] and to my quick test,
C-c C-c restores the original window configuration, /and the effect of C-u is
to make it also jump to the captured item/.
- org-match-sparse-tree’s docstring omits it can also match properties.
- [[info:org#Setting tags]] should inform that tag letters for the single-key
interface are case-sensitive. In "For this to work well you should assign
unique letters to most of your commonly used tags.", replace "assign unique
letters" → "assign unique letters (case-sensitive)". After "In this
interface, you can use the following keys:", please write "a-zA-Z" instead of
"a-z". Finally, in the docstring of org-tag-alist, please replace "SELECT is
a character" → "SELECT is a case-sensitive letter".
- org-capture’s docstring could mention ID creation\\
org-capture creates an ID property if org-id-link-to-org-use-id is set to t.
This is already documented in that option’s docstring, but perhaps it should
also be documented in org-capture’s docstring and [[info:org#Using capture]].
The reason is that if a user is surprised that org-capture created an ID
property, he will look in org-capture’s docstring or perhaps in the manual
section. He may not remember to check org-id-link-to-org-use-id’s docstring.
- org-startup-folded’s docstring misreports the default value of
org-agenda-inhibit-startup. The docstring’s last paragraph need changing.
- org-agenda-todo-ignore-deadlines’ docstring about ’far
The documentation of 'far says:
#+BEGIN_QUOTE
Don’t show TODO entries where a deadline has been defined, but the deadline
is not near. This is useful if you don’t want to use the todo list to figure
out what to do now.
#+END_QUOTE
I do not understand this reasoning.
- I believe that many people use .emacs.d/init.el instead of .emacs. To better
reflect this reality, should not Org’s manual use the expression "Emacs init
file" instead of ".emacs"?
- Typos and small corrections:
- Docstring of org-agenda-show-inherited-tags
#+BEGIN_QUOTE
when the value of ‘org-agenda-use-tag-inheritance’ has been taken into
account.
#+END_QUOTE
"has been taken into account." → "enables tag inheritance for the given
agenda type."
- Docstring of org-agenda-week-view\\
In "Switch to daily view for agenda", "daily" → "weekly".
Emacs : GNU Emacs 25.1.1 (x86_64-unknown-linux-gnu, GTK+ Version 3.18.9)
of 2016-09-18
Package: Org mode version 9.0 (9.0-elpaplus @
/home/jorge/.emacs.d/elpa/org-plus-contrib-20161102/)
current state:
==============
(setq
org-capture-prepare-finalize-hook '(J-insert-created-and-id-all)
org-clocktable-defaults '(:maxlevel 2 :lang "en" :scope file :block nil
:wstart 1
:mstart 1 :tstart nil :tend nil :step nil :stepskip0
nil
:fileskip0 nil :tags nil :emphasize nil :link nil
:narrow 40!
:indent t :formula nil :timestamp nil :level nil
:tcolumns nil
:formatter nil)
org-tab-first-hook '(org-babel-hide-result-toggle-maybe
org-babel-header-arg-expand)
org-footnote-section "Notas de rodapé"
org-icalendar-combined-agenda-file "~/org/org.ics"
org-insert-heading-hook '(org-id-get-create t)
org-speed-command-hook '(org-speed-command-default-hook
org-babel-speed-command-hook)
org-special-ctrl-k t
org-agenda-entry-text-maxlines 3
org-occur-hook '(org-first-headline-recenter)
org-metaup-hook '(org-babel-load-in-session-maybe)
org-html-format-drawer-function #[514 "\207" [] 3 "\n\n(fn NAME CONTENTS)"]
org-priority-faces '((65 :slant italic :weight bold :foreground "red"
:background
"black")
(66 :slant italic :weight bold :foreground "red"
:background "cyan")
(67 :slant italic :weight bold :foreground "red")
(68 :slant italic :weight bold) (69 . italic) (70
. default)
(71 :foreground "gold") (72 :foreground "yellow")
(73 :foreground "#ffff50"))
org-latex-format-inlinetask-function
'org-latex-format-inlinetask-default-function
org-confirm-shell-link-function 'yes-or-no-p
org-id-link-to-org-use-id 'create-if-interactive
org-finalize-agenda-hook '(J-org-agenda-to-appt-refresh)
org-after-tags-change-hook '(org-expiry-insert-created)
org-ascii-format-inlinetask-function 'org-ascii-format-inlinetask-default
org-icalendar-use-deadline '(event-if-not-todo event-if-todo todo-due)
org-export-default-language "pt_BR"
org-agenda-sticky t
org-list-allow-alphabetical t
org-special-ctrl-a/e t
org-ascii-text-width 79
org-agenda-custom-commands '(("j" "Now, agenda and TODOs"
((tags "now" nil)
(agenda ""
((org-agenda-span 1)
(org-agenda-time-grid (quote (nil nil nil))))
)
(tags-todo "-dia-@GYNO"
((org-agenda-todo-ignore-deadlines (quote
all))
(org-agenda-todo-ignore-scheduled (quote
all))
(org-agenda-todo-ignore-timestamp
org-deadline-warning-days)
)
)
)
((org-agenda-compact-blocks t)
(org-agenda-tags-todo-honor-ignore-options t)
(org-agenda-tag-filter-preset (quote
("-hide"))))
)
("p" "Now, agenda and TODOs (personal)"
((tags "now" nil)
(agenda ""
((org-agenda-span 1)
(org-agenda-time-grid (quote (nil nil nil))))
)
(tags-todo "-dia-@GYNO"
((org-agenda-todo-ignore-deadlines (quote
all))
(org-agenda-todo-ignore-scheduled (quote
all))
(org-agenda-todo-ignore-timestamp
org-deadline-warning-days)
)
)
)
((org-agenda-compact-blocks t)
(org-agenda-tags-todo-honor-ignore-options t)
(org-agenda-tag-filter-preset (quote ("-@WO"
"-hide"))))
)
("w" "Now, agenda and TODOs (work)"
((tags "now" nil)
(agenda ""
((org-agenda-span 1)
(org-agenda-time-grid (quote (nil nil nil))))
)
(tags-todo "-dia"
((org-agenda-todo-ignore-deadlines (quote
all))
(org-agenda-todo-ignore-scheduled (quote
all))
(org-agenda-todo-ignore-timestamp
org-deadline-warning-days)
)
)
)
((org-agenda-compact-blocks t)
(org-agenda-tags-todo-honor-ignore-options t)
(org-agenda-tag-filter-preset
(quote ("+@w" "-@CASAO" "-hide")))
)
)
)
org-latex-format-headline-function 'org-latex-format-headline-default-function
org-expiry-handler-function 'org-toggle-archive-tag
org-expiry-inactive-timestamps t
org-todo-keyword-faces '(("DELEGATED" . "cyan") ("FEEDBACK_" . "#0080FF")
("FEEDBACK" . "blue") ("FIX_COMMITTED" . "cyan"))
org-capture-templates '(("g" "Tarefa pessoal" entry
(id "700430e5-0c9d-498a-beb6-db384cd34655") "* TODO
%i%?")
("G" "Entrada pessoal" entry
(id "700430e5-0c9d-498a-beb6-db384cd34655") "* %i%?")
("w" "Tarefa de trabalho" entry
(id "9f62fc99-2050-40a9-a751-cdab2051c629") "* TODO
%i%?")
("W" "Entrada de trabalho" entry
(id "9f62fc99-2050-40a9-a751-cdab2051c629") "* %i%?")
("a" "Templates com tags :now:mtnt:")
("ag" "Tarefa pessoal :now:mtnt:" entry
(id "4be6b760-4677-450c-a0a3-84955a413547") "* TODO
%i%?")
("aG" "Entrada pessoal :now:mtnt:" entry
(id "4be6b760-4677-450c-a0a3-84955a413547") "* %i%?")
("aw" "Tarefa de trabalho :now:mtnt:" entry
(id "2fce891b-3836-484f-adeb-0d5d43daad1c") "* TODO
%i%?")
("aW" "Entrada de trabalho :now:mtnt:" entry
(id "2fce891b-3836-484f-adeb-0d5d43daad1c") "* %i%?")
)
org-icalendar-use-scheduled '(event-if-todo todo-start)
org-after-todo-state-change-hook '(org-clock-out-if-current
org-expiry-insert-created)
org-latex-format-drawer-function #[514 "\207" [] 3 "\n\n(fn _ CONTENTS)"]
org-odt-format-headline-function 'org-odt-format-headline-default-function
org-use-tag-inheritance "[^_]$"
org-icalendar-timezone "Brazil/East"
org-src-mode-hook '(org-src-babel-configure-edit-buffer
org-src-mode-configure-edit-buffer)
org-agenda-before-write-hook '(org-agenda-add-entry-text)
org-babel-pre-tangle-hook '(save-buffer)
org-global-properties '(("Effort_ALL" .
"0:02 0:05 0:15 0:30 1:00 2:00 4:00 8:00 16:00 40:00
80:00 160:00")
)
org-log-redeadline 'note
org-mobile-allpriorities "A B C D E F G H I"
org-trigger-hook '(org-depend-trigger-todo)
org-mode-hook '(J-org-init
#[0 "\300\301\302\303\304$\207"
[add-hook change-major-mode-hook org-show-block-all append
local] 5]
#[0 "\300\301\302\303\304$\207"
[add-hook change-major-mode-hook org-babel-show-result-all
append
local]
5]
org-babel-result-hide-spec org-babel-hide-all-hashes org-eldoc-load)
org-refile-targets '((org-agenda-files :tag . "target_")
(org-agenda-files :maxlevel . 3))
org-outline-path-complete-in-steps nil
org-archive-hook '(org-attach-archive-delete-maybe)
org-agenda-sorting-strategy '((agenda habit-down time-up priority-down
category-keep)
(todo priority-down category-keep)
(tags todo-state-down priority-down
category-keep)
(search category-keep))
org-ascii-format-drawer-function #[771 " \207" [] 4 "\n\n(fn NAME
CONTENTS WIDTH)"]
org-odt-format-inlinetask-function 'org-odt-format-inlinetask-default-function
org-refile-use-outline-path t
org-enforce-todo-dependencies t
org-cycle-hook '(org-cycle-hide-archived-subtrees org-cycle-hide-drawers
org-cycle-show-empty-lines org-optimize-window-after-visibility-change)
org-load-hook '((lambda nil (require (quote J-org))))
org-log-refile 'time
org-agenda-finalize-hook '(J-org-agenda-to-appt-refresh)
org-lowest-priority 73
org-log-reschedule 'note
org-todo-keywords '((sequence "TODO(t@)" "FEEDBACK_(F@)" "FEEDBACK(f@)"
"CONTINUE(o@)"
"|" "DONE(d@)")
(sequence "|" "CANCELED(c@)") (sequence "|"
"DELEGATED(e@)")
(sequence "|" "FIX_COMMITTED(i@)"))
org-modules '(org-bbdb org-bibtex org-docview org-gnus org-id org-info org-irc
org-mhe
org-rmail org-w3m org-depend org-expiry)
org-fast-tag-selection-single-key t
org-link-abbrev-alist '(("google" . "https://www.google.com/search?q="))
org-catch-invisible-edits 'error
org-confirm-elisp-link-function 'yes-or-no-p
org-metadown-hook '(org-babel-pop-to-session-maybe)
org-expiry-wait "+10y"
org-odt-format-drawer-function #[514 "\207" [] 3 "\n\n(fn NAME CONTENTS)"]
org-icalendar-store-UID t
org-default-priority 70
org-blocker-hook '(org-depend-block-todo
org-block-todo-from-children-or-siblings-or-parent)
org-icalendar-alarm-time 20
org-html-format-headline-function 'org-html-format-headline-default-function
org-link-parameters '(("w3m" :store org-w3m-store-link)
("rmail" :follow org-rmail-open :store
org-rmail-store-link)
("mhe" :follow org-mhe-open :store org-mhe-store-link)
("irc" :follow org-irc-visit :store org-irc-store-link)
("info" :follow org-info-open :export org-info-export
:store
org-info-store-link)
("id" :follow org-id-open)
("gnus" :follow org-gnus-open :store
org-gnus-store-link)
("docview" :follow org-docview-open :export
org-docview-export
:store org-docview-store-link)
("bibtex" :follow org-bibtex-open :store
org-bibtex-store-link)
("bbdb" :follow org-bbdb-open :export org-bbdb-export
:complete
org-bbdb-complete-link :store org-bbdb-store-link)
("file+sys") ("file+emacs") ("doi" :follow
org--open-doi-link)
("elisp" :follow org--open-elisp-link)
("file" :complete org-file-complete-link)
("ftp" :follow (lambda (path) (browse-url (concat "ftp:"
path))))
("help" :follow org--open-help-link)
("http" :follow (lambda (path) (browse-url (concat
"http:" path))))
("https" :follow
(lambda (path) (browse-url (concat "https:" path))))
("mailto" :follow
(lambda (path) (browse-url (concat "mailto:" path))))
("message" :follow
(lambda (path) (browse-url (concat "message:" path))))
("news" :follow (lambda (path) (browse-url (concat
"news:" path))))
("shell" :follow org--open-shell-link))
org-mobile-directory "~/Dropbox/MobileOrg"
org-icalendar-with-timestamps nil
org-export-with-smart-quotes t
org-tag-faces '(("now" . "red") ("MR" . "#C00000") ("h" . "#C0C0C0") ("dia"
. "#606060")
("r" . "#900000") ("va_" . "red"))
org-html-format-inlinetask-function
'org-html-format-inlinetask-default-function
org-agenda-files '("~/org/agenda/"
"~/Dropbox/wanessa_e_jorge/administração_clínica/derma-prime.org")
org-clock-out-hook '(org-clock-remove-empty-clock-drawer)
org-mobile-inbox-for-pull "~/org/agenda/from-mobile.org"
org-tag-alist '(("va_" . 97) ("carreira") (:startgroup) ("@casa" . 99)
(:grouptags)
("@CASAO" . 67) (:endgroup) (:startgroup) ("dia" . 100)
(:grouptags)
("h" . 104) (:endgroup) ("target_" . 101) ("distração")
("gagá")
(:startgroup) ("@gyn" . 103) (:grouptags) ("@GYNO" . 71)
(:endgroup)
(:startgroup) ("hide") (:grouptags) ("hide_" . 72) (:endgroup)
("Igreja" . 105) ("cai_muito" . 109) ("memorize" . 77)
(:startgroup)
("r" . 114) (:grouptags) ("MR" . 82) (:endgroup) ("now" . 110)
(:startgroup) ("pd" . 112) (:grouptags) ("{pd_.*}")
(:endgroup)
("política") ("saúde" . 115) ("social" . 83) ("mtnt" . 116)
("TIC" . 84)
(:startgroup) ("@w" . 119) (:grouptags) ("@w_") ("@WO" . 87) (:endgroup))
)
--
• I am Brazilian. I hope my English is correct and I welcome corrections.
• Please adopt free formats like PDF, ODF, Org, LaTeX, Opus, WebM and 7z.
• Free (as in free speech) software for Android: https://f-droid.org/
next reply other threads:[~2016-11-06 12:55 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-11-06 12:55 Jorge Morais Neto [this message]
2016-11-07 0:20 ` Bug: second batch of small documentation problems [9.0 (9.0-elpaplus @ /home/jorge/.emacs.d/elpa/org-plus-contrib-20161102/)] Nicolas Goaziou
2016-11-07 10:57 ` Jorge Morais Neto
2016-11-12 0:47 ` Nicolas Goaziou
2016-11-12 19:56 ` Jorge Morais Neto
2016-11-13 17:22 ` Nicolas Goaziou
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CAJR3QnevNB+foybMsBUcVdr1KMbQkeEmj874o2VRTgqM0=b-zg@mail.gmail.com' \
--to=jorge13515@gmail.com \
--cc=emacs-orgmode@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.