Cookbook

Welcome to the PmWiki Cookbook! Here you will find PmWiki add-ons and descriptions of how to customize PmWiki in lots of different ways.

ようこそPmWiki Cookbookへ! ここで、様々な方法でPmWikiをカスタマイズする、PmWikiアドオンと記述を見つけられるでしょう。

Note: These are PmWiki 2.0 and 2.1 recipes. See Cookbook-V1 for PmWiki 0.6 and 1.0 recipes.

注: これらはPmWiki2.0と2.1のレシピです。0.6と1.0はCookbook-V1を参照してください

Feel free to add your own contributions to the cookbook. If you want to write and distribute Cookbook recipes, see the cookbook module guidelines. In order to avoid duplication, make sure you check the archives of the discussion list for keywords of what you want to implement.

Cookbookへのあなた自身の貢献を加えるのに遠慮は要りません｡あなたがCookbookのレシピを書き, 配りたかったらCookbook モジュールガイドラインを見てください｡まず重複を避けるために、実行したいことのキーワードでディスカッションリストのアーカイブをチェックして下さい｡

Proposals and ideas for new features (as opposed to existing solutions) should be added to the PmWiki Issue Tracking System (PITS).

(既存の解決に対する)新たな提案とアイディアはPmWiki問題追跡システム(PITS)に加えられるべきです。

Administrative Tasks

自動再構築: 一定時間後にページを自動的に再構築
ページバックアップ: wiki.dディレクトリを圧縮ファイルにバックアップ
日時様式の変更: 日時フォーマット文字列やタイムゾーンを変更
バージョン比較: 同じファイル(ディレクトリ)を比較
ページ圧縮保存: PmWiki保存ページを圧縮フォーマットで持つ
コンテンツタイプ: コンテンツタイプとキャラクタセットの変更
HTML変換: HTMLページをPmWikiマークアップに変換
テーブル変換: HTMLテーブルを高度なテーブルマークアップに展開するsedスクリプト
テンプレートの編集: どうすれば、新規ページに対して"テンプレート編集"を確立できるのだろうか？
全体操作: 全てのWikiページにスクリプトを適用する
テキスト取り込み: テキストファイルセットをPmWikiファイルとして扱う
: A cookbook to run a PmWiki in a 'single group mode' for 'naive' end-users
ページの生成時刻: ページ下端に生成時刻を追加する
更新履歴のエクスポート: 最新nページのリスト表示
HTMLスタイルの削除: CSSファイルに含まれるHTMLすたいるを削除する
PmWikiリストア: アーカイブからリストアする
ページ共有: 複数のフィールド間で共有されるページ
検索結果: 検索結果かページリストで表示されるページを制限する
スキンの変更: ユーザにカスタムスキンの選択を許可する
スキン生成: 対話的にスキンを生成する
Popenを使わないSimuledit: popen()が許可されていないサーバでSimulEditを使う
SourceForgeサーバ: SourceForge.net'sプロジェクトのWeb環境でPmWikiを運用する
システムdiff: ページの履歴に、外部のdiff(1)を使用する
他の設定を使う: サーバ名(または他の決定的要因)による
ビューモード: モードコンセプトに則ったスキンにビューモードを加えるド基本ツール
WikiFarm ステップ・バイ・ステップ: WikiFarmを構築する方法の段階的な支持
WikiFarmの別解: WikiFarmを安全にするための簡単な手段
サイトの情報: Wikiページにサイトの情報を表示する
圧縮アップロード: アップロードされたファイルを圧縮して保存する
rsyncを利用してミラーリングする２つの方法: ２つのWikiシステムを同一に保つ
PHPファイル管理: PHPモジュールで作成されたファイルの操作方法

コンテンツマネジメントシステムアドオン

ブログ向けのバンドル: ブログエンジンとしてPmWikiを使う
ページリストによるブログ: 日付で名づけられたページを扱うためにページリストを改善する
[[Kind-of Blog]|ちょっとしたブログ]: PmWikiの簡単なブログ
CMS風: PmWikiにCMSの振る舞いを加える別の方法
CMSとしてのPmWiki: CMS(コンテンツマネジメントシステム)としてPmWikiを使う
JjsCMS: PmWikiを、通常ページの訪問者に、それを晒さないでCMSとして使う
ゲストブック: 簡単なゲストブックを提供する
フォーラム: とても簡単なフォーラム
簡単なフォーラム: シンプルだが、見栄えするフォーラム
友達に教える: 電子メールでページを送信する

編集

図表の作成: ページに棒グラフ(あるいは他形式の図表)を追加する
ダブルクリックで編集: ダブルクリックしてページを編集する
Emacs PmWiki Mode: Opening/editing/saving PmWiki source from within Emacs, also known as pmwiki-mode for Emacs (Unix/Linux, etc.)
エクセルの貼り付け: スプレッドシート(エクセル)データを貼り付けて変換する
GUI編集: 編集ウィンドウにボタンを追加する
GUI編集　日付ボタン: GUI編集ツールバーに日付ボタンを追加する
PmWikiDraw: ブラウザでドローイングを編集する
リッチな編集: WYSIWYG文書の編集のためのワープロ風のリッチテキストエディタ
スペルチェッカ: PmWiki編集にスペルチェックを追加する
タイトルの編集: 編集フォームにタイトル入力フィールドを追加する
SubEthaEdit　PmWikiモード: サファリ互換スクリプトによる、PmWiki互換マックテキストエディタプラグイン
ユーザ構成: ユーザに編集フォーム構成オプションを追加
XML RPC: ブログAPIのようなXML-RPCインタフェイスを使用してPmWikiに接続する
投票: 簡単な投票集計手順
RyeVoting: グラフ出力付のラジオボタン投票
編集付きのインクルード: インクルードページ/セクション編集ボタンを追加する
セクション編集: wikiページを編集可能なセクションに分割する
ページ分割: wikiページを複数のサブページ/サブセクションに分割する

フォームツール

フォームレシピの比較: さまざまなフォームレシピの概略を示す
フォームの構築: WikiマークアップでHTMLフォームを作成する
フォーム: wikiページに入力フォームを作成する(PmWikiの一部)
フォームガイドシステム: 動的フォームにWikiページを作る
入力: wikiページに入力フォームを作成する(アドオン　レシピ)
Mail Form｜メールフォーム: 自身の電子メールアドレスを晒すことなくメールを送る
Mailform2｜メールフォーム2: 自身の電子メールアドレスを晒すことなくメールを送る。更なるオプション
Wikiフォーム: PITSのように、サポートに拡張する。Wikiページを使うフォームを定義する。それを作成するのと同様にエントリを更新する
新規ページボックス: 新しいページを作成するフォームを提供する(簡単に)
新規ページフォーム: フォームを用いて新しいページを追加する(より高度に)
ページ追加フォーム: 最初に他のページに名前を設置せずにページを追加する

関数拡張

略称の用語集: 省略のためのtooltipsを与えるために用語集のページを使用する
取り消し線を追加: フォームを使ってページにラインを挿入し、リンクをクリックすることにより削除する
逆リンク: 現在のページにリンクしているページをリストする
美化: wikiページでコードと文法の強調表示を行う
クリップボード: カット＆ペーストを行い、ページ間でリソース共有とテンプレートを埋める
文字カウント: ページの文字数と単語数を表示するために{$Glyphs}と{$Words}マークアップを追加
BibTeXを参照: ページで文献目録を使う
コメントボックス: (:commentbox:) マークアップを追加
目次を検索: 全文検索による結果リストとページリストを、より速くロードする
高速逆リンク: カテゴリページと他の逆リンクリストを、より速くロードさせる
高速検索: 検索、ページリストとカテゴリページを、より速くロードさせる
コメントページリンク: コメントページを作る簡単な方法
ディスカッションタブ: Wikipedia風のディスカッションタブ/トークの特徴
コメント: コメントを分離されたファイルに保存する、もうひとつのコメントエンジン
ソースブロック: 他のコードと文法のハイライティング(CodeBlockに代わる)
グーグルサイトマップ: GoogleサイトマップにPmWikiサイトを送信する方法
多言語: 単一のページで多言語翻訳を管理する方法
出力の圧縮: 出力とアーカイブを圧縮してロード速度を大幅に改善する
PEARのdiff: PHP PEARのDiffを衝突のマージに使う
ページリストの説明: ページリストマークアップとオプションの説明
ページリスト WikiTrail: WikiTrailのためにページリストマークアップを使う
PmWiki2PDF: サイトで湾クリックすることにより、PDFを作成する
PmWiki2PDFでバックアップ: サイト全体をPDFでバックアップする
PDF出版: いくつかのWikiページ集合を印刷向けPDFとして定義するF
PDF生成: htmldocを使い、現在のWikiページから、PDFを生成する
スライドショウ: Wikiページのスライド表示
Publish WikiTrail: Create a printable view of the pages on a WikiTrail as a single page
Simple Page Counter: Count number of hits to a page
CurrentVisitors: Ccount the number of visitors currently surfing on the site
VisitorsLogging: Create a daily log of PmWiki activity and delete old logs automatically
PITS: The PmWiki Issue Tracking System
Search Extensions: Add page jump, search quick reference, search publish and category publish capabilities
Search HighLight: Highlight searched item
Search Terms: Another version of the above that doesn't require skin modifications
Action Log: Keep a trace in a Pmwiki page of all actions performed on the site
Xajax Search: Provide preview of found pages
MarkForDelete: Mark pages for deletion and collected them for review

Images

Images AutoResizing: to resize images and create images links
Easy Gallery: How to create a gallery without additional scripts
ClipBoard: Generic tool, automates EasyGallery techniques
Embedded Gallery: How to embed the Menalto Gallery inside of PmWiki
PhpQuickGallery: Using an external gallery script with includeSite tag
Picture Gallery: Display uploaded pictures and automatically create thumbnails for preview.
ImageSets: User friendly simple galleries, independant of single wiki pages.
Simple Gallery: Adding a simple gallery (photo/picture album) to pmwiki
TinyWebGallery: Integration in pmwiki of this refined gallery
Background Images: Adding background images to divisions, tables and table cells
Flash: Insert "Flash" (*.swf) movies in wiki pages
RelativeUrls: Display images using relative URLs.
Rotate Markup: Enable "rotating" markup (images) in wiki pages
Script-Generated Images: in wiki pages
Svg: Scaleable Vector Grafic (*.svg) in wiki pages
ImgPopUp: Scales down images and open them in a new window with upload link.
PTViewer: Panoramic images in wiki pages.

Insertions/Uploads

Attach Links: Change the formatting of Attach: links
Attachlist Enhanced: List missing or orphaned attachments
CSV Include: Import csv-files into PmWiki tables
Fortune: Inserts a random fortune cookie.
Number of Articles: Inserts the number of articles in the wiki.
Random Page: Insert a random Wiki page from a list of pages.
Random Quote: Inserts a random line from a text file.
Applet: Inserts Java applets in wiki pages
NewsList: Short list of files that were changed
Include Url: Include external html pages in your Wiki Pages
Include Site: Include external html pages in your Wiki Pages with styling
Include WikiPage: Include wiki pages from other PmWiki 2.0 web sites.
Include XML: Transform XML with XSL in your wiki pages (RSS,...).
IncludeAble: Include a pmwiki page into a php script page.
IncludeFieldPage: Include a page from another field in a farm.
Update Attachments: Have every attachment appear with an "update" link
Upload Groups: Change attachments to be organized on a per-group or sitewide basis
Upload Types: Add/remove upload extensions

Layout modifications

All GroupHeader: Add page for sitewide style definition like GroupHeader for all groups
Compact PageList: Making output of a long pagelist compact.
Sidebar-style PageList: The default pagelist styles don't look like what normal people put in the sidebar. This one does.
Dict Index: Get page listings in a "dictionary index" format
PageList Templates: Define the layout of pagelists using wiki syntax from a wiki page
Film Script: Adding Film Script Styles
Font Sizer: Add-on skin module for easy change of font sizes
Group HomePage Change: Changing a group's default HomePage
Remove Question Mark: Remove the (annoying) question mark beside empty/newly created pages
Link PageCreateFmt Tooltip: Adding a "tooltip" to a link of a non-existent page
Random Title: Randomise browser titles using $WikiTitle
SideBar Name Change: Changing the SideBar name
SideBar Special: Setting up special-use SideBars
Farm SideBar: Using a single sidebar template for a wiki farm.
Superscript Line Spacing: Fix line spacing of superscripts and subscripts
Printing With Style: Printable view using stylesheet only

Links/Page handling

AddLink Bookmarklet: Fast add ref. of any current web page to a given Wiki page
AtLinks: Alternate solution for links with @ prefix @Page
Disabling WikiWords: How to disable the WikiWords on an entire site
External Links: Cause external links to open in a new window by default
Lazy WebLinks: Cause markup text beginning with "www." to be automatically converted into a link
Rename Page: Add ?action=rename option
Delete Action: Delete page via (password-protected) ?action=delete
Expire Diff: Remove a page's history (?action=expirediff)
Relative links: Create links using relative urls
Other Bookmarklets: Browser Toolbar bookmarks to edit a page, browse diffs, etc.
This Site: Add the InterMap prefix ThisSite: to your site
Multilink: Add the ability to support full-featured multilinks
Tags: Add free tags to a wiki site

Markup changes

Abbreviation Plurals: Prevent plural abbreviations from being formatted as a wikiword
ASCII Math: Embed mathematical formulas in wiki pages (no external tools required)
Chess Markup: Display chessboards using PGN and FEN notations
ChordPro: Embed ChordPro-formatted song sheets
Conditional Extensions: Extend conditional markup
Properties: Add properties to wiki pages
PageVariables: Add variables (such as {$Title}) from other pages in the current page
Conditional Markup Samples: Some sample definitions of PmWiki/ConditionalMarkup
Make Columns: Split a block of text into two columns
Make Many Columns: Make Many columns in your page
Enable HTML: Allow html tags in wiki pages
Formatting Simple Tables: A number of ways to automatically style Tables
Group List: Add markup to generate a list of all groups on the site
Linux Tex: Embed mathematical formulas in wiki pages (full LaTeX installation necessary)
Markdown Markup Extension: Use Markdown markup
Markup Extensions: Adds a wide range of markups
Media Categories: Impliments trouble-free markup similar to Media Wiki.
Mime TeX: Eembed mathematical formulas in wiki pages
Numbered Headers: and table of contents
Outline Lists: Use ordered lists for outlines (I. A. 1. i. etc.)
Dynamic Wiki Trails: Add pages to multiple trails, a page's current trail becomes URL dependent
PageTableOfContents: Automatically generate a table of contents for a wiki page
PostIt Notes: Yellow Stickies
Reverse Headings: Reverse the weights of !, !!, !!, etc.
Titled Links: Extract the link title from a page
Wiki Smileys: Additional markup used for displaying smiley graphics.
WordWrap Preformatted Text: Prevent long lines of text from stretching beyond the window edge
WP Categories: Wikipedia-like Categories-links processing.

Markup writing

This is information for those who wish to write recipes for markup changes.

Custom Markup: Basic information
Functions: Functions for the markup writer (for module writers, too)
Parsing Markup Arguments: For writing markup that takes parameters
Markup Ruleset Debugging: Show more information than ?action=ruleset
Regular Expressions: Tips&tricks for regular expression usage

Menu Tools

Expanding Menus: Creating expanding Sidebar menus with conditional markup
Expanding Menu: Creates a menu that expands to show only subpages in the current section
Horizontal Menu: Turn lists into horizontal menus
Horizontal Vertical Menu: Multilevel horizontal/vertical menu within wiki markup or e.g. Main/SideBar
Tracking Menu: Highlights current page
Trail Menu: Creates a tree menu from a trail
Tree Menu: Creates a tree like menu

Page Naming Schemes

Alternate Naming Scheme: using underscores
Clean Urls: Get pmwiki to use "clean urls" (w/o pmwiki.php)
Open Urls: Allows automatic creation of $ScriptUrl for Clean Urls, with HTTPS support
Page Paths: Allow pages to be shared among multiple groups
Subpage Markup: Allows a wiki page to have one level of subpage
Title Spaced: Capitalization and wikiwords

Personal Information Management (PIM)

To Do: Manage a list of to do items
VerySimpleToDo: An alternate to-do list implementation striving for simplicity
Quiz: Create a query / answer quiz with pmwiki
PmCalendar: Easy to theme calendar designed for PmWiki
Wiki Calendar: Creates a calendar, where each day is a wiki page
iCal Export: Exports wiki entries to iCal format

RSS Tools

Rss Improved: Improves feed compatibility, customizable -- includes support for Podcasting/enclosures.
See All RSS Changes: Solving problem of unrecognized changes when using 3rd-party-software
Rss Feed Display: Display RSS feeds in a wiki
RSS Simple: Create a simple blog-alike wiki page with rss feed for this page

Security/Authentication

System Tools

My PmWiki: Access to mysql
Per Group SubDirectories: Organise files in subdirectories for each group
Standalone: Run PmWiki in a "standalone" mode, without needing a webserver.
WikiCVSStorage: How to automatically archive your wiki using CVS.

Wiki-to-Wiki Conversion Tools

Convert UseMod: Convert pages in a UseMod directory to PmWiki
Wiki Markup Conversion: Helps to convert other wiki markup to PmWiki

Superseded recipes

Simple Image Float: Simple image float right, left and center with caption
Blocklist: Block postings based on content or IP address-old version (deprecated)
EditBar: Add a formatting toolbar (superseded by 2.0.beta16)
GettingMarkupArguments: For writing markup that takes parameters
SpacedWikiWords: Missing pithy explanation
Layout Edit Modified: Modify the edit page layout
Change Summary: Record a one-line summary of changes
Preview Top: Move the edit preview box to the top
Main Group Change: Changing the Main group
Removing left content: (removing the SideBar)
No Space Pre: Remove the leading space from <PRE> blocks.
Authenticated As Conditional: Conditional that depends on what the user is authenticated as
Move a page: to a different group, or rename it obsolete, see next recipe
RenamePage: Missing pithy explanation
Line Breaks: Honor line breaks (newlines) in the markup text
Use Common Pages In A Wiki Farm: like the edit templates
Code Block: Enhanced code and syntax highlighting in wiki pages (superseded by SourceBlock)