Re: Spell checking of the commentary section by checkdoc.el.

[Oliver Scholz]

Lute Kamstra <address@hidden> writes:

[...]
>> PS: By the way, I think we should introduce a new section whose
>>     content is Texinfo prefixed with `;; ', and we should then
>>     automatically build an "Emacs Packages Manuals" info page
>>     (separate from the emacs manual) that holds the doc of all
>>     those packages.

[Hey, I thought that only *I* have been thinking of this. :-)]

> That is a really nice idea.  However, editing Texinfo as comments in
> emacs-lisp-mode doesn't appeal to me.  :-(
[...]

We could use a simple markup language that makes sense for plain
text, but can be parsed into the appropriate info format. Like *bold*,
/italic/, _underlined_. <info: (elisp) Lirum Larum> for
references. And "== section ==", "=== subsection ===" or maybe ";;;;
section" and ";;;;;; subsection" for ... erm ... sections and
subsections. For example:

;;; Info:

;; == Symbols ==

;;    A "symbol" is an object with a unique name. This chapter
;; describes symbols, their components, their property lists, and how
;; they are created and interned. Separate chapters describe the use
;; of symbols as variables and as function names; see <info:(elisp)
;; Variables>, and <info: (elisp) Functions>. For the precise read
;; syntax for symbols, see <info: (elisp) Symbol Type>.

;;  You can test whether an arbitrary Lisp object is a symbol with
;; `symbolp':

;;  - Function: symbolp object
;;      This function returns `t' if OBJECT is a symbol, `nil' otherwise.

;; ----- Menu -----
;; * Symbol Components  Symbols have names, values, function definitions
[...]
;; ----------------


;; === Symbol Components ===

;;    Each symbol has four components (or "cells"), each of which
;; references another object:


etc. 

We could even provide a minor mode (or something like that) which uses
font-lock to display this section in the emacs-lisp buffer as it is
displayed in `C-h i'.


    Oliver
-- 
26 Floréal an 211 de la Révolution
Liberté, Egalité, Fraternité!