<< Cookbook.EmacsPmWikiMode | Pages | Introduction >>
About pmwiki-mode for Emacs
pmwiki-mode is an Emacs-mode that allows you to edit wiki pages belonging to a wiki wiki web. Here are some of the features of pmwiki-mode:
- Opening pages
- Wiki pages are loaded directly from any (PmWiki) wiki wiki web.
- Wiki words can be followed, thus allowing you to browse the source.
- Editing pages
- Syntax highlighting of PmWiki markup.
- Search the site from within Emacs.
- Saving pages
- Pages are saved (uploaded) directly back to the wiki wiki web.
- Pages can be saved under a different name, or to a different site.
- Pages can be renamed
Thus you can use the browser for browsing, and Emacs for editing, just
<insert deity> intended...
Background and brief history
pmwiki-mode was written by Christian Ridderström for working with the Lyx wiki-wiki, where LyX is a WYSIWYM document processor (What You See Is What You Mean).
pmwiki-mode was originally based on another Emacs mode, called SimpleWikiEditMode [emacswiki.org], that enables you to edit pages from the Emacs wiki-wiki [emacswiki.org] from within in Emacs.
Description of pmwiki-mode (from doing
describe-mode in Emacs)
Mode to edit PmWiki pages. Typically you start by using the function `pmwiki-open' to open a URL, e.g.
Alternatively, the same page can be opened with `pmichaud-open' by giving 'Main.HomePage' or 'Main/HomePage' as argument. Similarly, a page at the LyX wiki can be opened using `lyx-open'.
Once a page has been opened, you can edit it and then save it using `pmwiki-save' or `pmwiki-save-as'. The latter function allows you to save the page with a new name, and even to a different wiki wiki web by giving an URL as argument.
To view the wiki page that you are editing in a browser, first save it and then use the command `pmwiki-browse'.
While editing the page, you can use `pmwiki-next' and `pmwiki-prev' to quickly go to the next and previous links. And when the point is on a link, you can use `pmwiki-follow to goto the page that the link points to, i.e. that page is opened in a new buffer.
`pmwiki-open' - Open wiki page specified by group/name or URL `pmwiki-next' - Goto the next WikiWord or free link?. `pmwiki-prev' - Goto the previous WikiWord or free link?. `pmwiki-follow' - Open (goto) page pointed to by link at point. `pmwiki-save' - Save current buffer to the wiki engine. `pmwiki-save-as' - Save buffer to new page specified by group/name or URL. `pmwiki-reload' - Reload the page. `pmwiki-browse' - Show current buffer in browser. `pmwiki-search' - Search the wiki site for a text. `pmwiki-map-site' - Generate a map of the site (all groups and pages). `pmwiki-delete' - Delete a page `pmichaud-open' - Open page from the Pmichaud wiki. `lyx-open' - Open a page from the LyX wiki. `lyx-save-as' - Save current buffer to page at the LyX wiki.