From f1d612d86e4094605358a27c08d2dd23d49f036e Mon Sep 17 00:00:00 2001 From: Michael Olson Date: Tue, 20 Jun 2006 18:10:46 +0000 Subject: [PATCH] Document through planner-publish.el. * ChangeLog: Update. * planner-el.texi (Publishing Planner pages): New section that documents planner-publish.el. (PSVN): New section that documents planner-psvn.el. * planner-publish.el (planner-html-inner-header): (planner-html-inner-footer): Docfix. git-archimport-id: mwolson@gnu.org--2006-planner-el/planner-el--devel--0--patch-47 --- ChangeLog | 131 +++++++++++++++++++++++++++++++++++++++++++++++++++++ planner-el.texi | 131 +++++++++++++++++++++++++++++++++++++++++++++++++++-- planner-publish.el | 8 ++-- 3 files changed, 263 insertions(+), 7 deletions(-) diff --git a/ChangeLog b/ChangeLog index 6e865ff..88a0fd4 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,134 @@ +2006-06-18 03:20:47 GMT John Sullivan patch-46 + + Summary: + Document planner-zoom. + Revision: + planner--main--1.0--patch-59 + + modified files: + planner-el.texi + + +2006-06-16 03:59:59 GMT Michael Olson patch-58 + + Summary: + Spot check documentation through planner-gnus.el. + Revision: + planner--main--1.0--patch-58 + + * planner-el.texi (Planner-Diary Advanced Features): Add a few index + entries. Document planner-export-diary.el. + (Emacs Relay Chat): Update the syntax. + + modified files: + planner-el.texi + + +2006-06-08 21:57:22 GMT Michael Olson patch-57 + + Summary: + planner-el.texi: Use shared Arch archive in instructions. + Revision: + planner--main--1.0--patch-57 + + * planner-el.texi (Installing from Arch): Use shared archive instead of + my personal archive. + + modified files: + planner-el.texi + + +2006-06-08 21:36:15 GMT Michael Olson patch-56 + + Summary: + Document new mailing lists in the manual. + Revision: + planner--main--1.0--patch-56 + + * planner-el.texi (Getting Help): Document new mailing + lists. + (Overview, Review, Sample Configuration Files): Point to Getting Help + section for mailing list information. + + modified files: + planner-el.texi + + +2006-06-08 20:54:08 GMT Michael Olson patch-55 + + Summary: + Update NEWS. + Revision: + planner--main--1.0--patch-55 + + * NEWS: Update. + + modified files: + NEWS + + +2006-06-08 20:26:57 GMT Michael Olson patch-54 + + Summary: + Move Debian stuff to its own branch. + Revision: + planner--main--1.0--patch-54 + + + removed files: + debian/.arch-ids/=id debian/.arch-ids/NEWS.id + debian/.arch-ids/README.Debian.id + debian/.arch-ids/changelog.id debian/.arch-ids/compat.id + debian/.arch-ids/control.id debian/.arch-ids/copyright.id + debian/.arch-ids/emacsen-install.id + debian/.arch-ids/emacsen-remove.id + debian/.arch-ids/emacsen-startup.id + debian/.arch-ids/planner-el.docs.id + debian/.arch-ids/planner-el.info.id debian/.arch-ids/rules.id + debian/NEWS debian/README.Debian debian/changelog + debian/compat debian/control debian/copyright + debian/emacsen-install debian/emacsen-remove + debian/emacsen-startup debian/planner-el.docs + debian/planner-el.info debian/rules + + removed directories: + debian debian/.arch-ids + + +2006-06-05 15:52:57 GMT Michael Olson patch-53 + + Summary: + Make Planner's keymap inherit from Muse's keymap. + Revision: + planner--main--1.0--patch-53 + + * planner.el (planner-mode-map): Apply patch from Adrian Aichner that + inherits the keymap from Muse, rather than copying it. We fall back to + copying it if the proper functionality does not exist in the user's + version of Emacs. + + modified files: + AUTHORS planner.el + + +2006-06-01 13:54:24 GMT Michael Olson patch-52 + + Summary: + Add explanation for timeclock.el error. + Revision: + planner--main--1.0--patch-52 + + * contrib/timeclock.el: Add an explanation of why we error out if the + person is not using XEmacs. + + * debian/emacsen-startup: Put Planner's contrib directory at the end of + the load-path. + + modified files: + ChangeLog ChangeLog.2005 Makefile.defs contrib/timeclock.el + debian/changelog debian/emacsen-startup + + 2006-05-30 21:14:09 GMT Michael Olson patch-51 Summary: diff --git a/planner-el.texi b/planner-el.texi index 5eeb0b5..562b439 100644 --- a/planner-el.texi +++ b/planner-el.texi @@ -147,6 +147,7 @@ More about Notes Publishing +* Publishing Planner pages:: planner-publish.el * Publishing Calendars:: planner-calendar.el * Authz Access Restriction:: planner-authz.el * RSS Publication:: Sharing notes with planner-rss.el @@ -215,6 +216,7 @@ Tracking Research and Resources Tracking Development * Log Edit:: Changelogs: planner-log-edit.el +* PSVN:: svn changesets: planner-psvn.el * XTLA:: TLA changesets: planner-xtla.el * Gnats:: Gnats: The GNU bug reporting system @@ -3393,6 +3395,7 @@ course, publishing is completely optional. Here are some more features related to publishing: @menu +* Publishing Planner pages:: planner-publish.el * Publishing Calendars:: planner-calendar.el * Authz Access Restriction:: planner-authz.el * RSS Publication:: Sharing notes with planner-rss.el @@ -3400,7 +3403,109 @@ Here are some more features related to publishing: * RDF Publication:: planner-rdf.el @end menu -@node Publishing Calendars, Authz Access Restriction, Publishing, Publishing + +@node Publishing Planner pages, Publishing Calendars, Publishing, Publishing +@comment node-name, next, previous, up +@subsection Publishing Planner pages +@cindex publishing +@cindex @file{planner-publish.el}, using + +The task of publishing Planner pages is handled by +@file{planner-publish.el}. It is loaded by default when Planner is +loaded. To publish an entire Planner project, set up +@code{muse-project-alist} (@pxref{Creating Your Planner}) and hit +@kbd{C-c C-p}. To publish an individual page, hit @kbd{C-c C-t}. + +Publishing works by providing Muse with the settings and environment for +Planner publishing. + +@subheading Styles provided + +The following publishing styles are available. + +@table @code + +@cindex publishing styles, planner-html +@item planner-html +Publish Planner pages to HTML. + +@cindex publishing styles, planner-xhtml +@item planner-xhtml +Publish Planner pages to XHTML. + +@cindex publishing styles, planner-xml +@item planner-xml +Publish Planner pages to XML. + +@end table + +@subheading Options provided + +The following options may be customized to enhance your publishing +experience. + +@table @code + +@item planner-publish-markup-regexps +List of markup rules for publishing Planner pages. + +@item planner-publish-markup-functions +Specify which function to use for publishing different kinds of markup. + +@item planner-publish-markup-tags +A list of custom HTML-like tags to recognize when publishing. + +@item planner-xml-markup-strings +Strings that are inserted to publish XML markup. + +@item planner-xml-header +Header used when publishing Planner XML files. +This may be text or a filename. + +@item planner-xml-footer +Footer used when publishing Planner XML files. +This may be text or a filename. + +@item planner-html-markup-strings +Strings that are inserted to publish HTML markup. + +@item planner-html-style-sheet +CSS stylesheet elements used in Planner HTML and XHTML files. +This can also be one or more @samp{} tags. + +@item planner-html-header +Header used when publishing Planner HTML files. +This may be text or a filename. + +@item planner-html-footer +Footer used when publishing Planner HTML files. +This may be text or a filename. + +@item planner-xhtml-header +Header used when publishing Planner XHTML files. +This may be text or a filename. + +@item planner-xhtml-footer +Footer used when publishing Planner XHTML files. +This may be text or a filename. + +@item planner-html-inner-header +Extra header section that can be embedded within +@code{planner-html-header} and @code{planner-xhtml-header}. + +@item planner-html-inner-footer +Extra header section that can be embedded within +@code{planner-html-footer} and @code{planner-xhtml-footer}. + +@item planner-publish-prepare-regexps +List of markup rules to apply before publishing a page with Planner. + +@item planner-publish-finalize-regexps +List of markup rules to apply after publishing a page with Planner. + +@end table + +@node Publishing Calendars, Authz Access Restriction, Publishing Planner pages, Publishing @comment node-name, next, previous, up @subsection Publishing Calendars @cindex calendar, publishing @@ -5162,11 +5267,12 @@ system. @menu * Log Edit:: Changelogs: planner-log-edit.el +* PSVN:: svn changesets: planner-psvn.el * XTLA:: TLA changesets: planner-xtla.el * Gnats:: Gnats: The GNU bug reporting system @end menu -@node Log Edit, XTLA, Tracking Development, Tracking Development +@node Log Edit, PSVN, Tracking Development, Tracking Development @comment node-name, next, previous, up @subsection Log Edit @cindex cvs, using Planner with @@ -5198,7 +5304,26 @@ note. @file{planner-log-edit.el} does not define any interactive functions. -@node XTLA, Gnats, Log Edit, Tracking Development +@node PSVN, XTLA, Log Edit, Tracking Development +@comment node-name, next, previous, up +@subsection PSVN +@cindex PSVN +@cindex @file{planner-psvn.el}, using + +This file allows you to refer to your svn changesets easily from within +a Planner page. You can load the module with @code{(require +'planner-psvn)}. + +PSVN URLs are of the form +@samp{psvn://http://my.svn-repos.at/svn/project1/trunk@@39} + +Additionally there is functionality to generate a note for your commits +via subversion: just set +@var{planner-psvn-log-edit-notice-commit-function} to t. + +@file{planner-psvn.el} does not define any interactive functions. + +@node XTLA, Gnats, PSVN, Tracking Development @comment node-name, next, previous, up @subsection XTLA @cindex XTLA diff --git a/planner-publish.el b/planner-publish.el index 1adec5d..27c094a 100644 --- a/planner-publish.el +++ b/planner-publish.el @@ -386,14 +386,14 @@ This may be text or a filename." :group 'planner-publish) (defcustom planner-html-inner-header "" - "Extra header section that can be embedded w/in existing -`planner-html-header'. This may be text or a filename." + "Extra header section that can be embedded within +`planner-html-header' and `planner-xhtml-header'." :type 'string :group 'planner-publish) (defcustom planner-html-inner-footer "" - "Extra footer section that can be embedded w/in existing -`planner-html-footer'. This may be text or a filename." + "Extra footer section that can be embedded within +`planner-html-footer' and `planner-xhtml-footer'." :type 'string :group 'planner-publish) -- 2.11.4.GIT