tec/org-mode
tec/org-mode
1
0
Fork 0
forked from mirrors/org-mode
Code Pull requests Releases Activity

org-info: Fix docstrings

Browse source 
* lisp/org-info.el (org-info-other-documents):
(org-info-map-html-url): Fix docstrings.

Suggested-by: Chunyang Xu <mail@xuchunyang.me>
This commit is contained in:
Nicolas Goaziou 2016-12-14 21:37:03 +01:00
parent b5cebbc412
commit 22a4896bf8
1 changed files with 13 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
lisp/org-info.el
View file

@ -97,21 +97,21 @@ Taken from <http://www.gnu.org/software/emacs/manual/html_mono/.>")
(defconst org-info-other-documents (defconst org-info-other-documents
'(("libc" . "http://www.gnu.org/software/libc/manual/html_mono/libc.html") '(("libc" . "http://www.gnu.org/software/libc/manual/html_mono/libc.html")
("make" . "http://www.gnu.org/software/make/manual/make.html")) ("make" . "http://www.gnu.org/software/make/manual/make.html"))
"Alist of documents generated from texinfo source. "Alist of documents generated from Texinfo source.
When converting info links to HTML, links to any one of these manuals are
When converting info links to html, links to any one of these manuals are converted to use these URL.")
converted to use these URL's.")
(defun org-info-map-html-url (filename) (defun org-info-map-html-url (filename)
"Given info FILENAME, either return it (plus '.html' suffix added) or convert "Return URL or HTML file associated to Info FILENAME.
it to URL pointing to the official page on internet, e.g., use gnu.org for all If FILENAME refers to an official GNU document, return a URL pointing to
emacs related documents. See `org-info-official-gnu-document' and the official page for that document, e.g., use \"gnu.org\" for all Emacs
`org-info-other-documents' for details." related documents. Otherwise, append \".html\" extension to FILENAME.
(if (member filename org-info-emacs-documents) See `org-info-emacs-documents' and `org-info-other-documents' for details."
(format "http://www.gnu.org/software/emacs/manual/html_mono/%s.html" (cond ((member filename org-info-emacs-documents)
filename) (format "http://www.gnu.org/software/emacs/manual/html_mono/%s.html"
(let ((url (cdr (assoc filename org-info-other-documents)))) filename))
(or url (concat filename ".html"))))) ((cdr (assoc filename org-info-other-documents)))
(t (concat filename ".html"))))
(defun org-info-export (path desc format) (defun org-info-export (path desc format)
"Export an info link. "Export an info link.