diff --git a/lisp/ChangeLog b/lisp/ChangeLog index 7c353be20..148409a09 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog @@ -1,3 +1,25 @@ +2008-05-08 Juanma Barranquero + + * org/org.el (org-modules, org-format-latex-options): + * org/org-archive.el (org-archive-stamp-time) + (org-archive-save-context-info): + * org/org-faces.el (org-hide): + * org/org-irc.el (org-irc-parse-link): + * org/org-macs.el (org-call-with-arg, org-autoload): + * org/org-mew.el (org-mew-store-link): + * org/org-remember.el (org-remember-store-without-prompt) + (org-remember-templates): Fix typos in docstrings. + + * org/org-info.el (org-info-store-link): Remove leftover docstring. + + * org/org-bbdb.el (org-bbdb-export): Remove leftover docstring. + (org-bbdb-anniversary-field, org-bbdb-extract-date-fun) + (org-bbdb-anniv-split): Fix typos in docstrings. + + * org/org-publish.el (org-publish-project-alist): Doc fixes. + (org-publish-use-timestamps-flag): Reflow docstring. + (org-publish-files-alist): Fix typos in docstring. + 2008-05-08 Carsten Dominik * org.el (org-set-visibility-according-to-property): New function. diff --git a/lisp/org-archive.el b/lisp/org-archive.el index db09b97bf..bfe0fe74b 100644 --- a/lisp/org-archive.el +++ b/lisp/org-archive.el @@ -50,14 +50,14 @@ use the first keyword in its list that means done." (defcustom org-archive-stamp-time t "Non-nil means, add a time stamp to entries moved to an archive file. -This variable is obsolete and has no effect anymore, instead add ot remove -`time' from the variablle `org-archive-save-context-info'." +This variable is obsolete and has no effect anymore, instead add or remove +`time' from the variable `org-archive-save-context-info'." :group 'org-archive :type 'boolean) (defcustom org-archive-save-context-info '(time file olpath category todo itags) "Parts of context info that should be stored as properties when archiving. -When a subtree is moved to an archive file, it looses information given by +When a subtree is moved to an archive file, it loses information given by context, like inherited tags, the category, and possibly also the TODO state (depending on the variable `org-archive-mark-done'). This variable can be a list of any of the following symbols: diff --git a/lisp/org-bbdb.el b/lisp/org-bbdb.el index f96df3092..9749797af 100644 --- a/lisp/org-bbdb.el +++ b/lisp/org-bbdb.el @@ -146,7 +146,7 @@ substitutions 1) the name of the record containing this anniversary, 2) the number of years, and 3) an ordinal suffix for the year. -Multiple anniversaries can be separated by \\n" +Multiple anniversaries can be separated by \\n." :type 'symbol :group 'org-bbdb-anniversaries :require 'bbdb) @@ -154,9 +154,9 @@ Multiple anniversaries can be separated by \\n" (defcustom org-bbdb-extract-date-fun 'org-bbdb-anniv-extract-date "How to retrieve `month date year' from the anniversary field. -Customize if you have already filled your bbdb with dates +Customize if you have already filled your BBDB with dates different from YYYY-MM-DD. The function must return a list (month -date year)" +date year)." :type 'function :group 'org-bbdb-anniversaries :require 'bbdb) @@ -182,7 +182,6 @@ date year)" "Create the export version of a BBDB link specified by PATH or DESC. If exporting to either HTML or LaTeX FORMAT the link will be italicised, in all other cases it is left unchanged." - "Create the exprt verison of a bbdb link." (cond ((eq format 'html) (format "%s" (or desc path))) ((eq format 'latex) (format "\\textit{%s}" (or desc path))) @@ -221,7 +220,7 @@ Argument TIME-STR is the value retrieved from BBDB." (string-to-number y)))) (defun org-bbdb-anniv-split (str) - "Split mutliple entries in the BBDB anniversary field. + "Split multiple entries in the BBDB anniversary field. Argument STR is the anniversary field in BBDB." (let ((pos (string-match "[ \t]" str))) (if pos (list (substring str 0 pos) diff --git a/lisp/org-faces.el b/lisp/org-faces.el index d580c0dc0..eac99bad1 100644 --- a/lisp/org-faces.el +++ b/lisp/org-faces.el @@ -41,7 +41,7 @@ '((((background light)) (:foreground "white")) (((background dark)) (:foreground "black"))) "Face used to hide leading stars in headlines. -The forground color of this face should be equal to the background +The foreground color of this face should be equal to the background color of the frame." :group 'org-faces) diff --git a/lisp/org-info.el b/lisp/org-info.el index 9b0e4eab7..24d04278e 100644 --- a/lisp/org-info.el +++ b/lisp/org-info.el @@ -47,7 +47,6 @@ ;; Implementation (defun org-info-store-link () "Store a link to an Info file and node." - "Store a link to an INFO folder or message." (when (eq major-mode 'Info-mode) (let (link desc) (setq link (org-make-link "info:" diff --git a/lisp/org-irc.el b/lisp/org-irc.el index 9ba6f5280..6687c69f9 100644 --- a/lisp/org-irc.el +++ b/lisp/org-irc.el @@ -88,7 +88,7 @@ (defun org-irc-parse-link (link) "Parse an IRC LINK and return the attributes found. Parse a LINK that looks like server:port/chan/user (port, chan -and user being optional) and return any or the port, channel or user +and user being optional) and return any of the port, channel or user attributes that are found." (let* ((parts (split-string link "/" t)) (len (length parts))) diff --git a/lisp/org-macs.el b/lisp/org-macs.el index 4b058cb80..a36a0ef6f 100644 --- a/lisp/org-macs.el +++ b/lisp/org-macs.el @@ -179,7 +179,7 @@ we turn off invisibility temporarily. Use this in a `let' form." (put 'org-let2 'lisp-indent-function 2) (defsubst org-call-with-arg (command arg) - "Call COMMAND interactively, but pretend prefix are was ARG." + "Call COMMAND interactively, but pretend prefix arg was ARG." (let ((current-prefix-arg arg)) (call-interactively command))) (defsubst org-current-line (&optional pos) @@ -194,7 +194,7 @@ we turn off invisibility temporarily. Use this in a `let' form." (>= (match-end n) pos))) (defun org-autoload (file functions) - "Establish autoload for all FUNCTIONS in FILE, if not boutd already." + "Establish autoload for all FUNCTIONS in FILE, if not bound already." (let ((d (format "Documentation will be available after `%s.el' is loaded." file)) f) diff --git a/lisp/org-mew.el b/lisp/org-mew.el index 7e9223fa3..2e2a7c1da 100644 --- a/lisp/org-mew.el +++ b/lisp/org-mew.el @@ -69,7 +69,7 @@ ;; Implementation (defun org-mew-store-link () - "Store a link to a MEW folder or message." + "Store a link to a Mew folder or message." (when (memq major-mode '(mew-summary-mode mew-virtual-mode)) (let* ((msgnum (mew-summary-message-number2)) (mark-info (mew-summary-get-mark)) diff --git a/lisp/org-publish.el b/lisp/org-publish.el index 53d88b62e..55cca9720 100644 --- a/lisp/org-publish.el +++ b/lisp/org-publish.el @@ -175,11 +175,11 @@ When the CDR of an element of org-publish-project-alist is in this second form, the elements of the list after :components are taken to be components of the project, which group together files requiring different publishing options. When you publish such a -project with M-x org-publish, the components all publish. +project with \\[org-publish], the components all publish. When a property is given a value in org-publish-project-alist, its setting overrides the value of the corresponding user variable - (if any) during publishing. However, options set within a file +\(if any) during publishing. However, options set within a file override everything. Most properties are optional, but some should always be set: @@ -207,7 +207,7 @@ set of file types publishable by org-publish, as well as the set of output formats. :publishing-function Function to publish file. The default is - org-publish-org-to-html, but other + `org-publish-org-to-html', but other values are possible. May also be a list of functions, in which case each function in the list is invoked @@ -225,39 +225,39 @@ and are equivalent to the corresponding user variables listed in the right column. See the documentation for those variables to learn more about their use and default values. - :language org-export-default-language - :headline-levels org-export-headline-levels - :section-numbers org-export-with-section-numbers - :table-of-contents org-export-with-toc - :emphasize org-export-with-emphasize - :sub-superscript org-export-with-sub-superscripts - :TeX-macros org-export-with-TeX-macros - :fixed-width org-export-with-fixed-width - :tables org-export-with-tables - :table-auto-headline org-export-highlight-first-table-line - :style org-export-html-style - :convert-org-links org-export-html-link-org-files-as-html - :inline-images org-export-html-inline-images - :expand-quoted-html org-export-html-expand - :timestamp org-export-html-with-timestamp - :publishing-directory org-export-publishing-directory - :preamble org-export-html-preamble - :postamble org-export-html-postamble - :auto-preamble org-export-html-auto-preamble - :auto-postamble org-export-html-auto-postamble - :author user-full-name - :email user-mail-address + :language `org-export-default-language' + :headline-levels `org-export-headline-levels' + :section-numbers `org-export-with-section-numbers' + :table-of-contents `org-export-with-toc' + :emphasize `org-export-with-emphasize' + :sub-superscript `org-export-with-sub-superscripts' + :TeX-macros `org-export-with-TeX-macros' + :fixed-width `org-export-with-fixed-width' + :tables `org-export-with-tables' + :table-auto-headline `org-export-highlight-first-table-line' + :style `org-export-html-style' + :convert-org-links `org-export-html-link-org-files-as-html' + :inline-images `org-export-html-inline-images' + :expand-quoted-html `org-export-html-expand' + :timestamp `org-export-html-with-timestamp' + :publishing-directory `org-export-publishing-directory' + :preamble `org-export-html-preamble' + :postamble `org-export-html-postamble' + :auto-preamble `org-export-html-auto-preamble' + :auto-postamble `org-export-html-auto-postamble' + :author `user-full-name' + :email `user-mail-address' The following properties may be used to control publishing of an index of files or summary page for a given project. :auto-index Whether to publish an index during - org-publish-current-project or org-publish-all. + `org-publish-current-project' or `org-publish-all'. :index-filename Filename for output of index. Defaults - to 'index.org' (which becomes 'index.html') + to 'index.org' (which becomes 'index.html'). :index-title Title of index page. Defaults to name of file. :index-function Plugin function to use for generation of index. - Defaults to 'org-publish-org-index', which + Defaults to `org-publish-org-index', which generates a plain list of links to all files in the project." :group 'org-publish @@ -265,8 +265,7 @@ index of files or summary page for a given project. (defcustom org-publish-use-timestamps-flag t "When non-nil, use timestamp checking to publish only changed files. -When nil, do no timestamp checking and always publish all -files." +When nil, do no timestamp checking and always publish all files." :group 'org-publish :type 'boolean) @@ -334,7 +333,7 @@ If there is no timestamp, create one." ;;; Mapping files to project names (defvar org-publish-files-alist nil - "Alist of files and their parent project. + "Alist of files and their parent projects. Each element of this alist is of the form: (file-name . project-name)") diff --git a/lisp/org-remember.el b/lisp/org-remember.el index c06489029..ffb1291d2 100644 --- a/lisp/org-remember.el +++ b/lisp/org-remember.el @@ -53,8 +53,8 @@ "Non-nil means, `C-c C-c' stores remember note without further promts. In this case, you need `C-u C-c C-c' to get the prompts for note file and headline. -When this variable is nil, `C-c C-c' give you the prompts, and -`C-u C-c C-c' trigger the fasttrack." +When this variable is nil, `C-c C-c' gives you the prompts, and +`C-u C-c C-c' triggers the fasttrack." :group 'org-remember :type 'boolean) @@ -87,7 +87,7 @@ You can set this on a per-template basis with the variable (defcustom org-remember-templates nil "Templates for the creation of remember buffers. When nil, just let remember make the buffer. -When not nil, this is a list of 5-element lists. In each entry, the first +When non-nil, this is a list of 5-element lists. In each entry, the first element is the name of the template, which should be a single short word. The second element is a character, a unique key to select this template. The third element is the template. diff --git a/lisp/org.el b/lisp/org.el index 327f1fa91..3dcb8685e 100644 --- a/lisp/org.el +++ b/lisp/org.el @@ -144,13 +144,13 @@ With prefix arg HERE, insert it at point." (defcustom org-modules '(org-bbdb org-bibtex org-gnus org-info org-jsinfo org-irc org-mew org-mhe org-rmail org-vm org-wl) "Modules that should always be loaded together with org.el. -If a description starts with , the file is not part of emacs +If a description starts with , the file is not part of Emacs and loading it will require that you have downloaded and properly installed the org-mode distribution. You can also use this system to load external packages (i.e. neither Org core modules, not modules from the CONTRIB directory). Just add symbols -to the end of the list. If the package is called org-xyz.e, then you need +to the end of the list. If the package is called org-xyz.el, then you need to add the symbol `xyz', and the package must have a call to (provide 'org-xyz)" @@ -1959,13 +1959,13 @@ forth between agenda and calendar." :matchers ("begin" "$" "$$" "\\(" "\\[")) "Options for creating images from LaTeX fragments. This is a property list with the following properties: -:foreground the foreground color for images embedded in emacs, e.g. \"Black\". - `default' means use the forground of the default face. +:foreground the foreground color for images embedded in Emacs, e.g. \"Black\". + `default' means use the foreground of the default face. :background the background color, or \"Transparent\". `default' means use the background of the default face. -:scale a scaling factor for the size of the images +:scale a scaling factor for the size of the images. :html-foreground, :html-background, :html-scale - The same numbers for HTML export. + the same numbers for HTML export. :matchers a list indicating which matchers should be used to find LaTeX fragments. Valid members of this list are: \"begin\" find environments