Commit d2e58b01 authored by David Byers's avatar David Byers
Browse files

Started on variable documentation to generate DocBook from.

Detailed changes:
> 	* vars.el.in: Started working on variable documentation.
>
parent d6856f19
2003-01-09 David Byers <david.byers@swipnet.se> 2003-01-09 David Byers <david.byers@swipnet.se>
* vars.el.in: Started working on variable documentation.
* option-edit.el (lyskom-create-widget): Insert the variable name * option-edit.el (lyskom-create-widget): Insert the variable name
in the buffer, after the help toggle. This is to make the buffer in the buffer, after the help toggle. This is to make the buffer
searchable for the actual variable names. searchable for the actual variable names.
......
...@@ -30,6 +30,9 @@ ...@@ -30,6 +30,9 @@
;;;; This file contains almost all the variables used in lyskom. ;;;; This file contains almost all the variables used in lyskom.
;;;; ;;;;
;;;; Note: put "**" at the front of docstrings that are ready
;;;; for use in DocBook autogeneration.
(setq lyskom-clientversion-long (setq lyskom-clientversion-long
(concat lyskom-clientversion-long (concat lyskom-clientversion-long
...@@ -99,9 +102,17 @@ Inheritance only works with the LysKOM buffer handling functions." ...@@ -99,9 +102,17 @@ Inheritance only works with the LysKOM buffer handling functions."
(def-kom-var kom-dont-read-saved-variables '(kom-dont-read-saved-variables (def-kom-var kom-dont-read-saved-variables '(kom-dont-read-saved-variables
lyskom-login-hook) lyskom-login-hook)
"*Non-nil means don't read some variables from the server. "'*Determines which LysKOM variables to not store in the server.
t means don't read any variables. A list means don't read variables that
are in the list.") For the most part you do not have to modify this variable. Any variables
set before LysKOM is loaded will not be read from the server.
This variable should `nil', `t' or a list of symbols.
The value `nil' means read all variables from the server. The value
`t' means read no variables from the server. When the value is a list
of symbols, those variables will not be read from the server.
Any other values are reserved for future use.")
(defmacro lyskom-maybe-setq (var value) (defmacro lyskom-maybe-setq (var value)
"This is a wrapper around setq that does nothing "This is a wrapper around setq that does nothing
...@@ -127,16 +138,43 @@ if the variable is in kom-dont-read-saved-variables." ...@@ -127,16 +138,43 @@ if the variable is in kom-dont-read-saved-variables."
'((t ("\\<bug[ \t\n]+\\([0-9]+\\)\\>" '((t ("\\<bug[ \t\n]+\\([0-9]+\\)\\>"
"http://bugzilla.lysator.liu.se/show_bug.cgi?id=\\1" "http://bugzilla.lysator.liu.se/show_bug.cgi?id=\\1"
0 t))) 0 t)))
"*Links in the text. "**Defines patterns for automatic links in the text.
This list is an alist where the car is a conference number and the cdr
a list of link specifications for that conference. Use the value t as the This variable defines patterns to look for in text and convert to
car to apply the specification in all conferences. Each link specification links to URLs. The value of this variable must be an alist, where the
is a list \(PATTERN REPLACEMENT HIGHLIGHT IGNORE-CASE), where PATTERN is key (car) is a conference number and the value (cdr) is a list of link
a regexp to look for in the text, REPLACEMENT is a replacement text to specifications for that conference. The special value `t' for the key
generate a URL from a match for REGEXP (see the NEWTEXT argument to indicates a list of patterns to apply in all conferences. Key values
replace-in-string for more information), HIGHLIGHT is the match group to other than positive integers and `t' are reserved for future use.
highlight in the LysKOM buffer (use 0 for the entire match) and IGNORE-CASE
is a flag: when non-nil case is ignored when looking for REGEXP." Each link specification is in turn a list \(`PATTERN' `REPLACEMENT'
`HIGHLIGHT' `IGNORE-CASE'), where `PATTERN' is a regular expression to
look for in the text, `REPLACEMENT' is used to generate a URL from the
text matching `PATTERN', `HIGHLIGHT' is the pattern group to highlight
as a URL and `IGNORE-CASE' specifies whether matching is
case-sensitive or not.
Each text is examined for each `PATTERN'. If a match is found, a URL
is created from `REPLACEMENT'. All characters except \ are copied
verbatim. The backslash character starts one of the following
sequences:
Sequence Meaning
\& Substitute the matched text
\N Substitute match for text matching the Nth (...)
group in `PATTERN'
\\ Insert one backslash.
The `HIGHLIGHT' parameter specifies which (...) group in `PATTERN'
to highlight as an URL. Use `0' to highlight the entire match.
Finally, if `IGNORE-CASE' is `t', then ignore character case while
looking for `PATTERN'. Values other than `t' and `nil' are reserved
for future use.
When a text has more than one recipient, links will be generated for
all recipients. The order in which the recipients are examined and
the priority among links that match the same text is undefined."
server) server)
...@@ -175,7 +213,8 @@ is a flag: when non-nil case is ignored when looking for REGEXP." ...@@ -175,7 +213,8 @@ is a flag: when non-nil case is ignored when looking for REGEXP."
(lambda (arg) (/ (logb (car arg)) 2))) (lambda (arg) (/ (logb (car arg)) 2)))
(lyskom-plusp . lyskom-get-text-below-point) (lyskom-plusp . lyskom-get-text-below-point)
(lyskom-minusp lyskom-get-text-above-point abs)))) (lyskom-minusp lyskom-get-text-above-point abs))))
"Defines how prefix arguments are used to find a text-no to operate on. "*Defines how prefix arguments are used to find a text-no to operate on.
The cars on the list are either one of the functions which invokes The cars on the list are either one of the functions which invokes
`lyskom-read-text-no-prefix-arg' (typically the one of the kom-* functions), `lyskom-read-text-no-prefix-arg' (typically the one of the kom-* functions),
or the value t for the strategy common to all such functions. For functions in or the value t for the strategy common to all such functions. For functions in
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment