From f23fbf35e0419a5d070d19eb1282109365e2cb29 Mon Sep 17 00:00:00 2001 From: Doug Kearns Date: Wed, 15 Jul 2009 18:33:57 +1000 Subject: [PATCH] Start cleaning up Muttator documentation. --- muttator/NEWS | 64 ++++++++-------- muttator/content/config.js | 18 +++++ muttator/locale/en-US/asciidoc.conf | 115 ++++++++++++++++++---------- muttator/locale/en-US/xhtml11.css | 16 ++++ vimperator/TODO | 1 + xulmus/locale/en-US/asciidoc.conf | 2 +- 6 files changed, 144 insertions(+), 72 deletions(-) diff --git a/muttator/NEWS b/muttator/NEWS index ec9983c4..8e71f9cc 100644 --- a/muttator/NEWS +++ b/muttator/NEWS @@ -1,61 +1,61 @@ 2009-XX-XX * version 0.6a1pre * add 'titlestring' option - * rename FolderLoaded autocommand event to FolderLoad - * add the DOMLoad autocommand event + * rename *FolderLoaded* autocommand event to *FolderLoad* + * add the *DOMLoad* autocommand event * add 'online' option * add 'smtpserver' option 2009-03-29 * version 0.5 * fixes for recent TB nightly changes - * new "threads" option (non-functional for now) - * new "archivefolder" option + * new 'threads' option (non-functional for now) + * new 'archivefolder' option * small bug fixes 2008-08-03: * version 0.4 - * new 'autoexternal' option to edit new messages/reply with the external editor by default + * new 'autoexternal' option to edit new messages/reply with the external editor by default. NOTE: You must set this option in your .muttatorrc, as options are not shared between the main thunderbird window and the compose window! - * various "l" mappings for labeling messages - * "p" to open RSS message in browser - * "y" to yank sender or RSS URL - * "Y" to yank subject - * "R" to reply to all - * new compose mappings: s, t and i: Focus subject:, To: or message body - * q quits composer now - * new "x" mapping to toggle HTML display (is there a need for "simple HTML"?) - * new "h" mapping to toggle headers + * various *l* mappings for labeling messages + * [m]p[m] to open RSS message in browser + * [m]y[m] to yank sender or RSS URL + * [m]Y[m] to yank subject + * [m]R[m] to reply to all + * new compose mappings: [m]s[m], [m]t[m] and [m]i[m] - Focus subject:, To: or message body + * [m]q[m] quits composer now + * new [m]x[m] mapping to toggle HTML display (is there a need for "simple HTML"?) + * new [m]h[m] mapping to toggle headers 2008-06-04: * version 0.3 * new tab related mappings + commands - * new :contacts and :contact commands for address book operations - * new :message command - * new -- COMPOSE -- mode with mutt-like keybindings (y to send message, e to edit message) + * new [c]:contacts[c] and [c]:contact[c] commands for address book operations + * new [c]:message[c] command + * new -- COMPOSE -- mode with mutt-like keybindings ([m]y[m] to send message, [m]e[m] to edit message) * external editor support for sending messages - * m to open a new message compose window - * new M command to send a new message to the sender of the currently selected message - * completions for :{go,copy,move}to commands - * :emptytrash command - * new * and # mappings to select next/prev message from same author (not perfect matching however) - * J, K, ]s, etc. search in closed threads now - * gj and gk to select messages in closed threads - * "t" to select current thread, use "lr" now to label a message as read - * KMail-like mode-independent scrolling with left/right and up/down + * [m]m[m] to open a new message compose window + * new [m]M[m] command to send a new message to the sender of the currently selected message + * completions for [c]:goto[c], [c]:copyto[c], [c]:moveto[c] commands + * [c]:emptytrash[c] command + * new [m]*[m] and [m]#[m] mappings to select next/prev message from same author (not perfect matching however) + * [m]J[m], [m]K[m], [m]]s[m], etc. search in closed threads now + * [m]gj[m] and [m]gk[m] to select messages in closed threads + * [m]t[m] to select current thread, use [m]lr[m] now to label a message as read + * KMail-like mode-independent scrolling with [m][m]/[m][m] and [m][m]/[m][m] * many small improvements 2008-04-30: * version 0.2 - * ctrl-s mappings to move messages to an "Archive" folder (inspired by gmail) - * new :moveto and :copyto commands - * u and ctrl-r mappings to undo/redo - * new muttator specific :help screen + * [m][m] mappings to move messages to an "Archive" folder (inspired by gmail) + * new [c]:moveto[c] and [c]:copyto[c] commands + * [m]u[m] and [m][m] mappings to undo/redo + * new Muttator specific :help screen * small bug fixes 2008-04-29: * version 0.1 - * first public release, straight port from vimperator with many basic mappings + * first public release, straight port from Vimperator with many basic mappings - +// vim: set filetype=asciidoc: diff --git a/muttator/content/config.js b/muttator/content/config.js index d0ba3fe6..04e9f1a4 100644 --- a/muttator/content/config.js +++ b/muttator/content/config.js @@ -186,6 +186,24 @@ const config = { //{{{ liberator.loadModule("hints", Hints); } + //////////////////////////////////////////////////////////////////////////////// + ////////////////////// STYLES ////////////////////////////////////////////////// + /////////////////////////////////////////////////////////////////////////////{{{ + + let img = Image(); + img.src = "chrome://muttator/content/logo.png"; + img.onload = function () { + styles.addSheet(true, "logo", "chrome://liberator/locale/*", + ".muttator-logo {" + <> + display: inline-block; + background: url({img.src}); + width: {img.width}px; + height: {img.height}px; + + "}", + true); + delete img; + }; + /////////////////////////////////////////////////////////////////////////////}}} ////////////////////// COMMANDS //////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////{{{ diff --git a/muttator/locale/en-US/asciidoc.conf b/muttator/locale/en-US/asciidoc.conf index 8d4fc5ff..986557af 100644 --- a/muttator/locale/en-US/asciidoc.conf +++ b/muttator/locale/en-US/asciidoc.conf @@ -4,63 +4,93 @@ author=Martin Stubenschrott email=stubenschrott@vimperator.org -# [header] -# -# -# -# -# -# -# {doctitle} -# -# -#
-#

{doctitle}

-# +[header] + + + + + + + + + + {doctitle} + + +
+ {doctitle} +
[replacements] -LOGO=
image:chrome://muttator/content/muttator.png[Muttator]
-HEADER=
image:chrome://vimperator/content/logo_white.png[Vimperator] +LOGO=
\[count\]=[count] -\[arg\]=[arg] -\[arg1\]=[arg1] -\[arg2\]=[arg2] -\[url\]=[url] -\[file\]=[file] -\[value\]=[value] -\[filter\]=[filter] \[!\]=[!] -# [macros] -# section:Introduction[tag1,tag2] +[macros] +# heading:Title[tag1,tag2] +(?su)(?.+?)\|(?!\+)=heading +# section:Title[tag1,tag2] (?su)(?.+?)\|(?!\+)=section +# subsection:Title[tag1,tag2] +(?su)(?.+?)\|(?!\+)=subsection # help:helptext[href] (?su)(?.+?)\|(?!\+)=help +# FIXME: this logo/donation banner is really ugly. --djk +[heading-inlinemacro] +{outfile@.*(intro|all).html::
} + + + + + +
<{outfile@.*all.html:h2:h1 style="border\: none"}>{target} +{3? {3}} +{2? {2}} +{1? {1}} +
+ # maximum 3 tags for now [section-inlinemacro] - + + + + +

{target}

 +
<{outfile@.*all.html:h3:h2}>{target} {3? {3}} {2? {2}} {1? {1}} -
+ +[subsection-inlinemacro] + + + + +
<{outfile@.*all.html:h4:h3}>{target} +{3? {3}} +{2? {2}} +{1? {1}} +
[help-inlinemacro] -{target} +{target} [quotes] |=tag ||=key -[o]=option +[o]=#option '=option2 -[c]=command -[m]=mapping -[a]=argument +[c]=#command +[m]=#mapping +[a]=#argument +[j]=#jump +# FIXME: this prevents all asciidoc attribute processing +# ^obviously it doesn't? --stepnem {|}=argument2 -[[|]]=argument3 # disable monospaced text as all our text is monospaced and it causes problems for some things += ^= @@ -68,16 +98,23 @@ HEADER=
| key=
|
-option=| -option2='|' -command=| -mapping=| +option=| +option2='|' +command=| +mapping=| +jump=| argument=| -argument2={|} +# NOTE: in certain contexts the unescaped '#' is stripped. As we're ditching +# asciidoc I won't bother investigating --djk +argument2=&\#123;|} argument3=[|] [specialwords] -warningwords=Warning: NOTE: Note: +warningwords=WARNING: Warning: IMPORTANT: Important: +infowords=NOTE: Note: [warningwords] {words} + +[infowords] +{words} diff --git a/muttator/locale/en-US/xhtml11.css b/muttator/locale/en-US/xhtml11.css index 9ebee13f..427cbe99 100644 --- a/muttator/locale/en-US/xhtml11.css +++ b/muttator/locale/en-US/xhtml11.css @@ -1,3 +1,6 @@ +/* keep the mozdev header */ +/* @import url(http://www.mozdev.org/skin/color/mozdev2k.css); */ + /* CSS stylesheet for XHTML produced by DocBook XSL stylesheets. Tested with XSL stylesheets 1.61.2, 1.67.2 @@ -308,6 +311,10 @@ span.warning { font-weight: bold; color: red; } +span.info { + font-weight: bold; + color: blue; +} fieldset.paypal { border: none; } @@ -318,6 +325,7 @@ fieldset.paypal { .command { font-weight: bold; color: #632610; + white-space: nowrap; } .mapping { font-weight: bold; @@ -327,6 +335,14 @@ fieldset.paypal { font-weight: bold; color: #106326; } + +.option, .mapping, .command { + text-decoration: none; +} +.option:hover, .mapping:hover, .command:hover { + text-decoration: underline; +} + .quoteblock { margin-left: 140px; padding-bottom: 10px; diff --git a/vimperator/TODO b/vimperator/TODO index 6b0d599a..1a1071f8 100644 --- a/vimperator/TODO +++ b/vimperator/TODO @@ -6,6 +6,7 @@ ARCHITECTURE: - I made a quick attempt at parameterizing it using attributes but it breaks Asciidoc formatting in certain unpredictable (to me at least) contexts. *sigh* --djk + - move as much as possible to common/* - decide on how to document Arrays in our jsdoc(ish) documentation. BUGS: diff --git a/xulmus/locale/en-US/asciidoc.conf b/xulmus/locale/en-US/asciidoc.conf index 20fcb711..8f1866c8 100644 --- a/xulmus/locale/en-US/asciidoc.conf +++ b/xulmus/locale/en-US/asciidoc.conf @@ -39,7 +39,7 @@ LOGO=
# FIXME: this logo/donation banner is really ugly. --djk [heading-inlinemacro] -{outfile@.*(intro|all).html::
} +{outfile@.*(intro|all).html::
}
<{outfile@.*all.html:h2:h1 style="border\: none"}>{target}