Skip to content

Doc strings within 80 char limit for kexport.el #224

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
matsl merged 2 commits into from
Jul 22, 2022
Merged

Doc strings within 80 char limit for kexport.el #224

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6ebe027
Doc strings within 80 char limit for kexport.el
matsl Jul 21, 2022
61512a1
Merge branch 'master' into long_doc_strings_kotl/kexport.el
matsl Jul 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions ChangeLog
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
2022-07-21 Mats Lidell <matsl@gnu.org>

* kotl/kexport.el:
* kotl/kcell.el: Shorten docs strings to be within 80 char limit.

2022-07-20 Mats Lidell <matsl@gnu.org>
Expand Down
44 changes: 25 additions & 19 deletions kotl/kexport.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
;; Author: Bob Weiner
;;
;; Orig-Date: 26-Feb-98
;; Last-Mod: 15-Jul-22 at 23:24:27 by Mats Lidell
;; Last-Mod: 18-Jul-22 at 21:50:10 by Mats Lidell
;;
;; Copyright (C) 1998-2022 Free Software Foundation, Inc.
;; See the "../HY-COPY" file for license information.
Expand Down Expand Up @@ -36,14 +36,15 @@
;;; ************************************************************************

(defvar kexport:input-filename nil
"This is automatically set to the full pathname of the file presently being exported.")
"This is automatically set to the full pathname of the exported file.")

(defvar kexport:output-filename nil
"This is automatically set to the full pathname of the file presently being exported.")
"This is automatically set to the full pathname of the exported file.")

(defcustom kexport:html-body-attributes
"BGCOLOR=\"#FFFFFF\"" ;; white background
"*String of HTML attributes attached to the <BODY> tag of an HTML exported koutline file."
"*String of HTML attributes attached to the <BODY> tag.
Part of an HTML exported koutline file."
:type 'string
:group 'hyperbole-koutliner)

Expand All @@ -55,7 +56,8 @@
:group 'hyperbole-koutliner)

(defcustom kexport:html-keywords nil
"*String of comma separated keywords to include with an HTML-exported document, or nil for none."
"*String of comma separated keywords to include with an HTML-exported document.
If nil, use no keywords."
:type '(choice (const nil)
(string))
:group 'hyperbole-koutliner)
Expand Down Expand Up @@ -108,9 +110,9 @@
(cons (format "&lt;\\s-*\\([^ \t\n\r,<>]+\\)\\s-*,\\s-*%s[^=&>]*&gt;"
kexport:kcell-partial-reference-regexp)
'kexport:html-file-klink))
"*List of (regexp . replacement-pattern) elements applied in order to the
contents of each kcell from a koutline exported to HTML format. Replacement
pattern may be:
"*List of (regexp . replacement-pattern) elements applied in order.
The elements are applied to the contents of each kcell from a
koutline exported to HTML format. Replacement pattern may be:
a string with references to regexp's grouping numbers, e.g. \\1, or
a function of one argument (it is passed the string being replaced in)
which returns the modified string. The function may use expressions such
Expand Down Expand Up @@ -160,7 +162,7 @@ li {
font-size: 0;
}
</style>\n"
"CSS that styles collapsible HTML-exported Koutline parent cells")
"CSS that styles collapsible HTML-exported Koutline parent cells.")

(defconst kexport:font-awesome-css-include-with-menus
"<style>
Expand Down Expand Up @@ -294,7 +296,7 @@ menuitem > menu > menuitem.hover > menu > menuitem{
}
/* End Drop-down menu CSS */
</style>\n"
"CSS that styles collapsible HTML-exported Koutline parent cells and menus")
"CSS that styles collapsible HTML-exported Koutline parent cells and menus.")

(defconst kexport:font-awesome-collapsible-javascript
"<script>
Expand Down Expand Up @@ -322,19 +324,20 @@ for (i = 0; i < coll.length; i++) {
});
}
</script>\n"
"JavaScript which expands/collapses HTML-exported Koutline parent cells")
"JavaScript which expands/collapses HTML-exported Koutline parent cells.")

;;; ************************************************************************
;;; Public functions
;;; ************************************************************************

;;;###autoload
(defun kexport:koutline (&optional soft-newlines-flag)
"Export the current buffer's koutline to the same named file with a \".html\" suffix.
"Export current buffer's koutline to the same named file with a \".html\" suffix.
Return the pathname of the html file created.

By default, this retains newlines within cells as they are. With optional prefix arg, SOFT-NEWLINES-FLAG,
hard newlines are not used. Also converts Urls and Klinks into Html hyperlinks."
By default, this retains newlines within cells as they are. With
optional prefix arg, SOFT-NEWLINES-FLAG, hard newlines are not
used. Also converts Urls and Klinks into Html hyperlinks."
(interactive "P")
(let ((export-from buffer-file-name)
(output-to (concat (file-name-sans-extension buffer-file-name) ".html")))
Expand All @@ -343,11 +346,13 @@ hard newlines are not used. Also converts Urls and Klinks into Html hyperlinks.

;;;###autoload
(defun kexport:display (&optional soft-newlines-flag)
"Export the current buffer's koutline to the same named file with a \".html\" suffix and display it in a web browser.
"Export the current buffer's koutline and display it in a web browser.
The buffer is exported to the same named file with a \".html\" suffix.
Return the pathname of the html file created.

By default, this retains newlines within cells as they are. With optional prefix arg, SOFT-NEWLINES-FLAG,
hard newlines are not used. Also converts Urls and Klinks into Html hyperlinks."
By default, this retains newlines within cells as they are. With
optional prefix arg, SOFT-NEWLINES-FLAG, hard newlines are not
used. Also converts Urls and Klinks into Html hyperlinks."
(interactive "P")
(let ((html-file (kexport:koutline soft-newlines-flag)))
(hact 'www-url (concat "file://" html-file))
Expand All @@ -356,8 +361,9 @@ hard newlines are not used. Also converts Urls and Klinks into Html hyperlinks.
;;;###autoload
(defun kexport:html (export-from output-to &optional soft-newlines-flag)
"Export a koutline buffer or file in EXPORT-FROM to html format in OUTPUT-TO.
By default, this retains newlines within cells as they are. With optional prefix arg, SOFT-NEWLINES-FLAG,
hard newlines are not used. Also converts Urls and Klinks into Html hyperlinks.
By default, this retains newlines within cells as they are. With
optional prefix arg, SOFT-NEWLINES-FLAG, hard newlines are not
used. Also converts Urls and Klinks into Html hyperlinks.
!! STILL TODO:
Make delimited pathnames into file links (but not if within klinks).
Copy attributes stored in cell 0 and attributes from each cell."
Expand Down