X-Git-Url: http://git.tremily.us/?a=blobdiff_plain;f=doc%2Fplugins%2Fwrite.mdwn;h=183675c53435319a8f629f838dc0eb8a38267aa7;hb=b2dea99417ebfee3d448ab6b49ca58cb2780258d;hp=bf7aab866aa6e7cdc61c6bb4f8815758b936ad43;hpb=dcadf1138897a1bb9ad97dc497d0b9c7a7ed1d6c;p=ikiwiki.git diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index bf7aab866..183675c53 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -1,172 +1,37 @@ -ikiwiki [[plugins]] are written in perl. Each plugin is a perl module, in -the `IkiWiki::Plugin` namespace. The name of the plugin is typically in -lowercase, such as `IkiWiki::Plugin::inline`. Ikiwiki includes a -`IkiWiki::Plugin::skeleton` that can be fleshed out to make a useful -plugin. `IkiWiki::Plugin::pagecount` is another simple example. +Ikiwiki's plugin interface allows all kinds of useful [[plugins]] to be +written to extend ikiwiki in many ways. Despite the length of this page, +it's not really hard. This page is a complete reference to everything a +plugin might want to do. There is also a quick [[tutorial]]. [[toc levels=2]] -## Considerations +## Types of plugins + +Most ikiwiki [[plugins]] are written in perl, like ikiwiki. This gives the +plugin full access to ikiwiki's internals, and is the most efficient. +However, plugins can actually be written in any language that supports XML +RPC. These are called [[external]] plugins. + +A plugin written in perl is a perl module, in the `IkiWiki::Plugin` +namespace. The name of the plugin is typically in lowercase, such as +`IkiWiki::Plugin::inline`. Ikiwiki includes a `IkiWiki::Plugin::skeleton` +that can be fleshed out to make a useful plugin. +`IkiWiki::Plugin::pagecount` is another simple example. All perl plugins +should `use IkiWiki` to import the ikiwiki plugin interface. It's a good +idea to include the version number of the plugin interface that your plugin +expects: `use IkiWiki 2.00`. + +An external plugin is an executable program. It can be written in any +language. Its interface to ikiwiki is via XML RPC, which it reads from +ikiwiki on its standard input, and writes to ikiwiki on its standard +output. For more details on writing external plugins, see [[external]]. + +Despite these two types of plugins having such different interfaces, +they're the same as far as how they hook into ikiwiki. This document will +explain how to write both sorts of plugins, albeit with an emphasis on perl +plugins. -http://www.shoesorder.biz -Our Products page: - http://www.shoesorder.biz/Shoes/Nike_Air_Max/ - http://www.shoesorder.biz/Shoes/Nike_Air_Max_90/ - http://www.shoesorder.biz/Shoes/Nike_Air_Max_91/ - http://www.shoesorder.biz/Shoes/Nike_Air_Max_95/ - http://www.shoesorder.biz/Shoes/Nike_Air_Max_97/ - http://www.shoesorder.biz/Shoes/Nike_Air_Max_360/ - http://www.shoesorder.biz/Shoes/Nike_Air_Max_Ltd/ - http://www.shoesorder.biz/Shoes/Nike_Air_Max_2003/ - http://www.shoesorder.biz/Shoes/Nike_Air_Max_2004/ - http://www.shoesorder.biz/Shoes/Nike_Air_Max_2005/ - http://www.shoesorder.biz/Shoes/Nike_Air_Max_2006/ - http://www.shoesorder.biz/Shoes/Nike_Air_Max_Tn_Plus/ - http://www.shoesorder.biz/Shoes/Nike_Air_Max_Tn_2/ - http://www.shoesorder.biz/Shoes/Nike_Air_Max_Tn_3/ - http://www.shoesorder.biz/Shoes/Nike_Air_Max_Tn_4/ - http://www.shoesorder.biz/Shoes/Nike_Air_Max_Tn_6/ - http://www.shoesorder.biz/Shoes/Nike_Shox/ - http://www.shoesorder.biz/Shoes/Nike_Shox_NZ/ - http://www.shoesorder.biz/Shoes/Nike_Shox_R4/ - http://www.shoesorder.biz/Shoes/Nike_Shox_R5/ - http://www.shoesorder.biz/Shoes/Nike_Shox_OZ/ - http://www.shoesorder.biz/Shoes/Nike_Shox_VC/ - http://www.shoesorder.biz/Shoes/Nike_Shox_LV/ - http://www.shoesorder.biz/Shoes/Nike_Shox_TL/ - http://www.shoesorder.biz/Shoes/Nike_Shox_TL_2/ - http://www.shoesorder.biz/Shoes/Nike_Shox_TL_3/ - http://www.shoesorder.biz/Shoes/Nike_Shox_Bmw/ - http://www.shoesorder.biz/Shoes/Nike_Shox_Ride/ - http://www.shoesorder.biz/Shoes/Nike_Shox_Turbo/ - http://www.shoesorder.biz/Shoes/Nike_Shox_Elite/ - http://www.shoesorder.biz/Shoes/Nike_Shox_Rival/ - http://www.shoesorder.biz/Shoes/Nike_Shox_Classic/ - http://www.shoesorder.biz/Shoes/Nike_Shox_Monster/ - http://www.shoesorder.biz/Shoes/Nike_Shox_Dendara/ - http://www.shoesorder.biz/Shoes/Nike_Shox_Energia/ - http://www.shoesorder.biz/Shoes/Nike_Air_Jordan/ - http://www.shoesorder.biz/Shoes/Nike_air_Jordan_1_Retro_I/ - http://www.shoesorder.biz/Shoes/Nike_air_Jordan_2_Retro_II/ - http://www.shoesorder.biz/Shoes/Nike_air_Jordan_3_Retro_III/ - http://www.shoesorder.biz/Shoes/Nike_air_Jordan_4_Retro_IV/ - http://www.shoesorder.biz/Shoes/Nike_air_Jordan_5_Retro_V/ - http://www.shoesorder.biz/Shoes/Nike_air_Jordan_6_Retro_VI/ - http://www.shoesorder.biz/Shoes/Nike_air_Jordan_7_Retro_VII/ - http://www.shoesorder.biz/Shoes/Nike_air_Jordan_8_Retro_VIII/ - http://www.shoesorder.biz/Shoes/Nike_air_Jordan_9_Retro_IX/ - http://www.shoesorder.biz/Shoes/Nike_air_Jordan_10_Retro_X/ - http://www.shoesorder.biz/Shoes/Nike_air_Jordan_11_Retro_XI/ - http://www.shoesorder.biz/Shoes/Nike_air_Jordan_12_Retro_XII/ - http://www.shoesorder.biz/Shoes/Nike_air_Jordan_13_Retro_XIII/ - http://www.shoesorder.biz/Shoes/Nike_air_Jordan_14_Retro_XIV/ - http://www.shoesorder.biz/Shoes/Nike_air_Jordan_15_Retro_XV/ - http://www.shoesorder.biz/Shoes/Nike_air_Jordan_16_Retro_XVI/ - http://www.shoesorder.biz/Shoes/Nike_air_Jordan_17_Retro_XVII/ - http://www.shoesorder.biz/Shoes/Nike_air_Jordan_18_Retro_XVIII/ - http://www.shoesorder.biz/Shoes/Nike_air_Jordan_19_Retro_XIX/ - http://www.shoesorder.biz/Shoes/Nike_air_Jordan_20_Retro_XX/ - http://www.shoesorder.biz/Shoes/Nike_air_Jordan_21_Retro_XXI/ - http://www.shoesorder.biz/Shoes/Nike_Air_Force_1/ - http://www.shoesorder.biz/Shoes/Nike_Air_Force_1_Low/ - http://www.shoesorder.biz/Shoes/Nike_Air_Force_1_High/ - http://www.shoesorder.biz/Shoes/Nike_Air_Force_1_Custom/ - http://www.shoesorder.biz/Shoes/Nike_Air_Force_1_Dollar/ - http://www.shoesorder.biz/Shoes/Nike_Air_Force_1_Clear/ - http://www.shoesorder.biz/Shoes/Nike_Air_Force_1_Carving/ - http://www.shoesorder.biz/Shoes/Nike_Air_Dunk/ - http://www.shoesorder.biz/Shoes/Nike_Air_Rift/ - http://www.shoesorder.biz/Shoes/Nike_Air_Zoom_Total_90/ - http://www.shoesorder.biz/Shoes/Nike_Lebron_James/ - http://www.shoesorder.biz/Shoes/Nike_New_Free_5.0/ - http://www.shoesorder.biz/Shoes/Nike_Air_Foamposite/ - http://www.shoesorder.biz/Shoes/Nike_Football/ - http://www.shoesorder.biz/Shoes/Nike_Basketball/ - http://www.shoesorder.biz/Shoes/Nike_Kobe_Harache/ - http://www.shoesorder.biz/Shoes/APE_Bape_Star/ - http://www.shoesorder.biz/Shoes/Prada_Gucci/ - http://www.shoesorder.biz/Shoes/Reebok/ - http://www.shoesorder.biz/Shoes/Converse/ - http://www.shoesorder.biz/Shoes/Puma/ - http://www.shoesorder.biz/Shoes/Timberland_Boots/ - http://www.shoesorder.biz/Shoes/Timberland_Boots_High/ - http://www.shoesorder.biz/Shoes/Timberland_Boots_Low/ - http://www.shoesorder.biz/Shoes/Timberland_Boots_Mid/ - http://www.shoesorder.biz/Shoes/Timberland_Boots_Womens/ - http://www.shoesorder.biz/Shoes/Adidas/ - http://www.shoesorder.biz/Shoes/Adidas_Good_Year/ - http://www.shoesorder.biz/Shoes/Adidas_Running_Shoes/ - http://www.shoesorder.biz/Shoes/Adidas_Football_Shoes/ - http://www.shoesorder.biz/Shoes/Adidas_Basketball_Shoes/ - http://www.shoesorder.biz/Shoes/Adidas_T_MAC/ - http://www.shoesorder.biz/Shoes/Adidas_35_Years/ -1)Nike Air Max 90 91 95 97 2003 2004 2005 2006 2007 360 Ltd Tn Tn2 Tn3 Tn4 Tn6 180 Deluxe Misc Impax Run 2 Tuned Sirocco Air Zoom Spiridon Solas Air Huarache Burst Tailwind Classic BW. - Nike Air Max 90 Sneakers, Nike Air Max 91 Supplier, Nike Air Max 95 Shoes Supplier, Nike Air Max 97 Trainers.? - Nike Air Max 2003 Wholesale, Nike Air Max 2004 Shoes Wholesale, Nike Air Max 2005 Shop, Nike Air Max 2006 Shoes Shop. - Nike Air Max 360 Catalogs, Nike Air Max Plus Tn Shoes Catalogs, Nike Air Max Plus Tn 2 Women's Men's Shoes. - Nike Air Max Plus Tn 3 Customize, Nike Air Max Plus Tn 4 Shoes Customize, Nike Air Max Plus Tn 6 Supply, Nike Air Max Ltd Shoes Supply. -2)Nike Shox NZ R3 R4 R5 VC OZ LV TNTL Rival Bmw Ride 2:40 Turbo Classic Monster Dendara Energia TL TL2 TL3 TL4 TL5 CL Explodine Junga Respond Cognescenti, Shox Disobey Vivacity Warrior Andalucia Rhythmic Aprisa Trainer Rollin BB4 Bella IL Electric TR Propulsion XT. - Nike Shox Nz Sale, Nike Shox R4 Shoes Sale, Nike Shox R5 Store, Nike Shox OZ Shoes Store, Nike Shox VC Distributor. - Nike Shox LV Shoes Distributor, Nike Shox TL Manufacturer, Nike Shox TL 2 Shoes Manufacturer, Nike Shox TL 3 Running Shoes. - Nike Shox TL 5 Mens Womens Shoes, Nike Shox Bmw Wholesaler, Nike Shox Ride Shoes Wholesaler, Nike Shox Turbo Sneaker. - Nike Shox Elite Seller, Nike Shox Rival Shoes Seller, Nike Shox Classic Trainer, Nike Shox Monster Suppliers. - Nike Shox Energia Shoes Suppliers, Nike Shox Dendara Collection. http://www.shoesshop.biz -3)Nike Air Jordan 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 Jumpman Series Melo 5.5 Apparels Zero Nu Retro Melo 1.5, Air Jordan I II III IV V VI VII VIII IX X XI XII XIII XIV XV XVI XVII XVIII XIX XX XXI. - Nike Air Jordan Retro 1-I Shoes Collection, Nike Jordan 2-II Chaussure, Nike Air Jordan 3-III Chaussure Shoes, Nike Jordan 4-IV Catalog. - Nike Air Jordan 5-V Shoes Catalog, Nike Jordan 6-VI Customized, Nike Air Jordan 7-VII Shoes Customized, Nike Jordan 8-VIII Wholesalers. - Nike Air Jordan 9-IX Shoes Wholesalers, Nike Jordan 10-X Factory, Nike Air Jordan 11-XI Shoes Factory, Nike Jordan 12-XII Sell, Nike Air Jordan 13-XIII Shoes Sell. - Nike Air Jordan 14-XIV Exporter, Nike Jordan 15-XV Shoes Exporter, Nike Air Jordan 16-XVI Offer, Nike Jordan 17-XVII Shoes Offer, Nike Air Jordan 18-XVIII Manufacture. - Nike Air Jordan 19-XIX Shoes Manufacture, Nike Jordan 20-XX Directory, Nike Air Jordan 21-XXI Shoes Directory. http://www.shoesebuy.com -4)Nike Air Dunk Mid Low High Air Dunk SB. - 5)Timberland Boots High Low Mid and Timberland Boots Womens. - Timberland Boots High Importer, Timberland Boots Low Shoes Importer, Timberland Boots Mid Sales, Timberland Boots Womens Shoes Sales. -6)Adidas Good Year Running Shoes Basketball Football Shoes 35 Years 35th Anniversary T Mac 3.5 4.5 5 6. - Adidas Shoes Buyer, Adidas Good Year Shoes Buyer, Adidas Running Shoes Import, Adidas 35 Years Shoes Import. - Adidas Basketball Shoes, Adidas Football Shoes, Adidas T Mac 3.5 4.5 5 6 Export . -7)Nike Air Rift Dunk Kobe Harache 2k3 2k4 2k5 2k6 Lebron James Air Foamposite Nike Air Zoom Total 90,Nike Total 90,Nike Basketball Shoes, Nike Football Shoes Nike New Free 5.0. -8)APE Bape Star Shoes Export Prada Gucci Shoes Offers, Bapesta Bape Sta Women Men Shoes Reebok Shoes Offers Puma Shoes Buy Converse Shoes Series. - We offer grade A quality products online,Our products are authentic quality with original box. http://www.nikeshoesstore.com -9)Nike Air Force 1 I one's Low High Mid Custom Dollar, Nike Air Force 1 I one's Clear Carving Transparence. -10)Nike Sneakers,Nike Shoes Supplier,Nike Trainers,Nike Shoes Wholesale,Nike Shoes Shop,Nike Shoes Catalogs,Nike Men's Women's Shoes,Nike Shoes Customize. - Nike Shoes Supply,Nike Shoes Sale,Nike Shoes Store,Nike Shoes Distributor,Nike Shoes Manufacturer,Nike Running Shoes,Nike Mens Womens Shoes,Nike Shoes Wholesaler. - Nike Sneaker,Nike Shoes Seller,Nike Shoes Trainer,Nike Shoes Suppliers,Nike Shoes Collection,Nike Shoes Chaussure,Nike Shoes Catalog,Nike Shoes Customized. - Nike Shoes Wholesalers,Nike Shoes Factory,Nike Shoes Sell,Nike Shoes Exporter,Nike Shoes Offer,Nike Shoes Manufacture,Nike Shoes Directory,Nike Shoes Importer. - Nike Shoes Sales,Nike Shoes Buyer,Nike Basketball Shoes,Nike Football Shoes,Nike Shoes Import,Nike Shoes Export,Nike Men Women Shoes,Nike Shoes Offers. - Nike Classic Shoes,Nike Shoes Buy,Nike Authentic Shoes,Nike Shoes Discount,Nike Shoes Stock,Nike Shoes Series,Nike Cheap Shoes,Nike Shoes Business,Nike Shoes Selection,louis vuitton LV huarache. - Nike Shoes Produce,Nike Shoes Burberry,Nike Talaria Shoes,Nike Training Shoes,Nike Shoes Trade,Nike Shoes Outlet,Nike Flightposite Shoes,Nike Shoes In stock. -10.EUR Size: - Womens Shoes Sizes | 35 35.5 36 37 37.5 38 39 39.5 40, Mens Shoes Sizes | 41 41.5 42 42.5 43 43.5 44 45 46. - USA Size: - Women's shoes sizes | 4 5 5.5 6 7 8 8.5, Men's shoes sizes | 8 8.5 9 9.5 10 10.5 11 11.5 12 13 13.5. - U.K Size: - women shoes sizes | 5 5.5 6.5 7 8 8.5 9, man shoes size | 8 8.5 9 9.5 10 10.5 11 12 13. -11.We are looking forward to doing business with you! - Please visit our web site http://www.shoesorder.biz Model Colors: White Bule Red Gold Golden Yellow Pink Black Silver purple orange, Green Brown Grey beige darkish fawn buff powder blue. - celandine green French grey grayish pearl blue azury aqua baby pink laurel green lilac puce atrous carmine navy blue, olive-drab bottle green claret modena nut-brown. -12.Our marketing to USA America US United States UK England United Kingdom IT Italy NT Netherlands China Chinese, Germany DE Greece GR France FR Spain Portugal Switzerland Switzerland Brazil Chile Peru Canada Japan Korea Australia Hongkong Canada Mexico Etc.. and sell to all over the world. -13.Other brand shoes | Air Pippen II Michael Vick Bo Jackson Charles Barkley, Kobe Bryant Penny Hardaway, Scottie Pippen. - Lebron James Trainer Max 94 Carmelo Anthony Foamposite Pro, Air Flight 89 Tim Duncan Misc Deion Sanders Vince Carter.? - Kevin Garnett Dennis Rodman Ken Griffey Vintage, Larry Johnson (Grand Mama) Training Running Shoes. -14.Adidas Stan Smith Superstar Top Ten Tennis Vintage Country 73 Gazelle Vintage Gazelle 2 Half Shells ZXZ Adicolor Series, - All Black Kobe Bryant Pro Model Italia 74 Pistol Pete Adidas 1.1B Superstar 35th Anniversary Kevin Garnett 3. - Kareem Abdul-Jabbar Collection Muhammad Ali Collection The TMAC 5 Night Jogger Campus Forest Hills Metro Attitude Utility CF Low Mid. - Beckenbauer Allround Orion Handball 5 Plug Samba Classic Forum Mid Low Point Guard Fleetwood Low Dallas M V2 Running P.T. - Brougham New York BW Navy Detroit Wilhelm Bungert Monaco GP The TMAC 4.5 E.P. Pro Low The TMAC 3.5 Court P.T. - TMAC 3 Missy Elliot TMAC 2 Training P.T. The TMAC Boulevard Server Shoes Furtivo Decade Samoa Sandals Concord Nizza Instinct Attitude Racewalk. -15.Reebok Shoes The Answer 2 3 4 5 6 7 8 9, S Carter Daddy Yankee Ventilator Womens Ice Cream (Pharrell) Ice Cream (Pharrell). - OG Classic Mid Low DMX Mega Lux Pump Bringback Pump Opus Battleground Pump Fury Omni Pump Pump Preseason Court Victory Pump. - Workout Low DGK Stevie Williams Boulevard Bringback Settlement Bringback ATR the Pump DMX Mega Pump Wrapshear Pump Fury 2. - Coolout Shaq Attaq I Legacy S Carter Tennis II Iverson Line G Unit GXT Pump, NBA Downtime Royal Court Racer X Majo, CL Amaze BB5000 Supercourt Misc. - Marc Jacobs Vans, FEIT K-Swiss Pro-Keds AND1 Pony Snoop Dogg, New Balance Pelle Pelle Fila DKNY Skechers Misc. -16.Nike Sneakers,Nike Supplier,Nike Trainers,Nike Wholesale,Nike Shop,Nike Catalogs,Nike Men's Shoes,Nike Customize. - Nike Supply,Nike Sale,Nike Store,Nike Distributor,Nike Manufacturer,Nike Running Shoes,Nike Mens Shoes,Nike Wholesaler. - Nike Sneaker,Nike Seller,Nike Trainer,Nike Suppliers,Nike Collection,Nike Chaussure,Nike Catalog,Nike Customized. - Nike Wholesalers,Nike Factory,Nike Sell,Nike Exporter,Nike Offer,Nike Manufacture,Nike Directory,Nike Importer. - Nike Sales,Nike Buyer,Nike Basketball Shoes,Nike Football Shoes,Nike Import,Nike Export,Nike Women Shoes,Nike Offers. - Nike Classic Shoes,Nike Buy,Authentic Nike Shoes,Nike Discount,Nike In Stock,Nike Series,Nike Cheap Shoes,Nike Business,Nike Selection. - Nike Produce,Nike Burberry,Nike Talaria Shoes,Nike Training Shoes,Nike Trade,Nike Outlet,Nike Flightposite Shoes,Nike In stock. - Email: shoesshop@yeah.net - MSN: Shoesshop@msn.com +## Considerations One thing to keep in mind when writing a plugin is that ikiwiki is a wiki *compiler*. So plugins influence pages when they are built, not when they @@ -179,16 +44,17 @@ being edited. ## Registering plugins -All plugins should `use IkiWiki` to import the ikiwiki plugin interface. - Plugins should, when imported, call `hook()` to hook into ikiwiki's processing. The function uses named parameters, and use varies depending on the type of hook being registered -- see below. Note that a plugin can call the function more than once to register multiple hooks. All calls to `hook()` should be passed a "type" parameter, which gives the type of hook, a "id" paramter, which should be a unique string for this plugin, and -a "call" parameter, which is a reference to a function to call for the -hook. +a "call" parameter, which tells what function to call for the hook. + +An optional "last" parameter, if set to a true value, makes the hook run +after all other hooks of its type. Useful if the hook depends on some other +hook being run first. ## Types of hooks @@ -216,18 +82,37 @@ configuration. It's called early in the startup process. The function is passed no values. It's ok for the function to call `error()` if something isn't configured right. +### refresh + + hook(type => "refresh", id => "foo", call => \&refresh); + +This hook is called just before ikiwiki scans the wiki for changed files. +It's useful for plugins that need to create or modify a source page. The +function is passed no values. + +### needsbuild + + + + hook(type => "needsbuild", id => "foo", call => \&needsbuild); + +This allows a plugin to manipulate the list of files that need to be +built when the wiki is refreshed. The function is passed a reference to an +array of pages that will be rebuilt, and can modify the array, either +adding or removing files from it. + ### filter hook(type => "filter", id => "foo", call => \&filter); Runs on the raw source of a page, before anything else touches it, and can -make arbitrary changes. The function is passed named parameters `page` and -`content` and should return the filtered content. +make arbitrary changes. The function is passed named parameters "page", +"destpage", and "content". It should return the filtered content. ### preprocess -Adding a [[PreProcessorDirective]] is probably the most common use of a -plugin. +Adding a [[ikiwiki/PreProcessorDirective]] is probably the most common use +of a plugin. hook(type => "preprocess", id => "foo", call => \&preprocess); @@ -238,16 +123,50 @@ Each time the directive is processed, the referenced function (`preprocess` in the example above) is called, and is passed named parameters. A "page" parameter gives the name of the page that embedded the preprocessor directive, while a "destpage" parameter gives the name of the page the -content is going to (different for inlined pages). All parameters included -in the directive are included as named parameters as well. Whatever the -function returns goes onto the page in place of the directive. +content is going to (different for inlined pages), and a "preview" +parameter is set to a true value if the page is being previewed. All +parameters included in the directive are included as named parameters as +well. Whatever the function returns goes onto the page in place of the +directive. + +An optional "scan" parameter, if set to a true value, makes the hook be +called during the preliminary scan that ikiwiki makes of updated pages, +before begining to render pages. This parameter should be set to true if +the hook modifies data in `%links`. Note that doing so will make the hook +be run twice per page build, so avoid doing it for expensive hooks. (As an +optimisation, if your preprocessor hook is called in a void contets, you +can assume it's being run in scan mode.) Note that if the [[htmlscrubber]] is enabled, html in -[[PreProcessorDirective]] output is sanitised, which may limit what your -plugin can do. Also, the rest of the page content is not in html format at -preprocessor time. Text output by a preprocessor directive will be -linkified and passed through markdown (or whatever engine is used to htmlize -the page) along with the rest of the page. +[[ikiwiki/PreProcessorDirective]] output is sanitised, which may limit what +your plugin can do. Also, the rest of the page content is not in html +format at preprocessor time. Text output by a preprocessor directive will +be linkified and passed through markdown (or whatever engine is used to +htmlize the page) along with the rest of the page. + +### linkify + + hook(type => "linkify", id => "foo", call => \&linkify); + +This hook is called to convert [[WikiLinks|WikiLink]] on the page into html +links. The function is passed named parameters "page", "destpage", and +"content". It should return the linkified content. Present in IkiWiki 2.40 +and later. + +Plugins that implement linkify must also implement a scan hook, that scans +for the links on the page and adds them to `%links`. + +### scan + + hook(type => "scan", id => "foo", call => \&scan); + +This hook is called early in the process of building the wiki, and is used +as a first pass scan of the page, to collect metadata about the page. It's +mostly used to scan the page for WikiLinks, and add them to `%links`. +Present in IkiWiki 2.40 and later. + +The function is passed named parameters "page" and "content". Its return +value is ignored. ### htmlize @@ -265,17 +184,28 @@ return the htmlized content. hook(type => "pagetemplate", id => "foo", call => \&pagetemplate); -[[Templates]] are filled out for many different things in ikiwiki, -like generating a page, or part of a blog page, or an rss feed, or a cgi. -This hook allows modifying those templates. The function is passed named -parameters. The "page" and "destpage" parameters are the same as for a -preprocess hook. The "template" parameter is a `HTML::Template` object that -is the template that will be used to generate the page. The function can -manipulate that template object. +[[Templates|wikitemplates]] are filled out for many different things in +ikiwiki, like generating a page, or part of a blog page, or an rss feed, or +a cgi. This hook allows modifying the variables available on those +templates. The function is passed named parameters. The "page" and +"destpage" parameters are the same as for a preprocess hook. The "template" +parameter is a [[cpan HTML::Template]] object that is the template that +will be used to generate the page. The function can manipulate that +template object. -The most common thing to do is probably to call $template->param() to add +The most common thing to do is probably to call `$template->param()` to add a new custom parameter to the template. +### templatefile + + hook(type => "templatefile", id => "foo", call => \&templatefile); + +This hook allows plugins to change the [[template|wikitemplates]] that is +used for a page in the wiki. The hook is passed a "page" parameter, and +should return the name of the template file to use, or undef if it doesn't +want to change the default ("page.tmpl"). Template files are looked for in +/usr/share/ikiwiki/templates by default. + ### sanitize hook(type => "sanitize", id => "foo", call => \&sanitize); @@ -318,8 +248,84 @@ source files that were rendered. Use this to hook into ikiwiki's cgi script. Each registered cgi hook is called in turn, and passed a CGI object. The hook should examine the -parameters, and if it will handle this CGI request, output a page and -terminate the program. +parameters, and if it will handle this CGI request, output a page +(including the http headers) and terminate the program. + +Note that cgi hooks are called as early as possible, before any ikiwiki +state is loaded, and with no session information. + +### auth + + hook(type => "auth", id => "foo", call => \&auth); + +This hook can be used to implement a different authentication method than +the standard web form. When a user needs to be authenticated, each registered +auth hook is called in turn, and passed a CGI object and a session object. + +If the hook is able to authenticate the user, it should set the session +object's "name" parameter to the authenticated user's name. Note that +if the name is set to the name of a user who is not registered, +a basic registration of the user will be automatically performed. + +### sessioncgi + + hook(type => "sessioncgi", id => "foo", call => \&sessioncgi); + +Unlike the cgi hook, which is run as soon as possible, the sessioncgi hook +is only run once a session object is available. It is passed both a CGI +object and a session object. To check if the user is in fact signed in, you +can check if the session object has a "name" parameter set. + +### canedit + + hook(type => "canedit", id => "foo", call => \&pagelocked); + +This hook can be used to implement arbitrary access methods to control when +a page can be edited using the web interface (commits from revision control +bypass it). When a page is edited, each registered canedit hook is called +in turn, and passed the page name, a CGI object, and a session object. + +If the hook has no opinion about whether the edit can proceed, return +`undef`, and the next plugin will be asked to decide. If edit can proceed, +the hook should return "". If the edit is not allowed by this hook, the +hook should return an error message for the user to see, or a function +that can be run to log the user in or perform other action necessary for +them to be able to edit the page. + +This hook should avoid directly redirecting the user to a signin page, +since it's sometimes used to test to see which pages in a set of pages a +user can edit. + +### editcontent + + hook(type => "editcontent", id => "foo", call => \&editcontent); + +This hook is called when a page is saved (or previewed) using the web +interface. It is passed named parameters: `content`, `page`, `cgi`, and +`session`. These are, respectively, the new page content as entered by the +user, the page name, a `CGI` object, and the user's `CGI::Session`. + +It can modify the content as desired, and should return the content. + +### formbuilder + + hook(type => "formbuilder_setup", id => "foo", call => \&formbuilder_setup); + hook(type => "formbuilder", id => "foo", call => \&formbuilder); + +These hooks allow tapping into the parts of ikiwiki that use [[cpan +CGI::FormBuilder]] to generate web forms. These hooks are passed named +parameters: `cgi`, `session`, `form`, and `buttons`. These are, respectively, +the `CGI` object, the user's `CGI::Session`, a `CGI::FormBuilder`, and a +reference to an array of names of buttons to go on the form. + +Each time a form is set up, the `formbuilder_setup` hook is called. +Typically the `formbuilder_setup` hook will check the form's title, and if +it's a form that it needs to modify, will call various methods to +add/remove/change fields, tweak the validation code for the fields, etc. It +will not validate or display the form. + +Just before a form is displayed to the user, the `formbuilder` hook is +called. It can be used to validate the form, but should not display it. ### savestate @@ -340,7 +346,7 @@ namespace. These variables and functions are the ones most plugins need, and a special effort will be made to avoid changing them in incompatible ways, and to document any changes that have to be made in the future. -Note that IkiWiki also provides other variables functions that are not +Note that IkiWiki also provides other variables and functions that are not exported by default. No guarantee is made about these in the future, so if it's not exported, the wise choice is to not use it. @@ -350,6 +356,23 @@ A plugin can access the wiki's configuration via the `%config` hash. The best way to understand the contents of the hash is to look at [[ikiwiki.setup]], which sets the hash content to configure the wiki. +### %pagestate + +The `%pagestate` hash can be used by plugins to save state that they will need +next time ikiwiki is run. The hash holds per-page state, so to set a value, +use `%pagestate{$page}{$id}{$key}=$value`, and to retrieve the value, +use `%pagestate{$page}{$id}{$key}`. + +`$key` can be any string you like, but `$id` must be the same as the "id" +parameter passed to `hook()` when registering the plugin. This is so +ikiwiki can know when to delete pagestate for plugins that are no longer +used. + +When pages are deleted, ikiwiki automatically deletes their pagestate too. + +Note that page state does not persist across wiki rebuilds, only across +wiki updates. + ### Other variables If your plugin needs to access data about other pages in the wiki. It can @@ -357,9 +380,9 @@ use the following hashes, using a page name as the key: * `%links` lists the names of each page that a page links to, in an array reference. -* `%renderedfiles` lists names of the files rendered by a page, in an array - reference. -* `%pagesources` contains the name of the source file for a page. +* `%destsources` contains the name of the source file used to create each + destination file. +* `%pagesources` contains the name of the source file for each page. Also, the %IkiWiki::version variable contains the version number for the ikiwiki program. @@ -371,7 +394,7 @@ ikiwiki program. Hook into ikiwiki's processing. See the discussion of hooks above. Note that in addition to the named parameters described above, a parameter -named no_override is supported, If it's set to a true value, then this hook +named `no_override` is supported, If it's set to a true value, then this hook will not override any existing hook with the same id. This is useful if the id can be controled by the user. @@ -380,21 +403,24 @@ the id can be controled by the user. Logs a debugging message. These are supressed unless verbose mode is turned on. -#### `error($)` +#### `error($;$)` -Aborts with an error message. +Aborts with an error message. If the second parameter is passed, it is a +function that is called after the error message is printed, to do any final +cleanup. Note that while any plugin can use this for a fatal error, plugins should try to avoid dying on bad input, as that will halt the entire wiki build -and make the wiki unusable. So for example, if a [[PreProcessorDirective]] -is passed bad parameters, it's better to return an error message, which can -appear on the wiki page, rather than calling error(). +and make the wiki unusable. So for example, if a +[[ikiwiki/PreProcessorDirective]] is passed bad parameters, it's better to +return an error message, which can appear on the wiki page, rather than +calling error(). #### `template($;@)` -Creates and returns a HTML::Template object. The first parameter is the -name of the file in the template directory. The optional remaining -parameters are passed to HTML::Template->new. +Creates and returns a [[cpan HTML::Template]] object. The first parameter +is the name of the file in the template directory. The optional remaining +parameters are passed to `HTML::Template->new`. #### `htmlpage($)` @@ -403,12 +429,17 @@ page created from it. (Ie, it appends ".html".) #### `add_depends($$)` -Makes the specified page depend on the specified [[PageSpec]]. +Makes the specified page depend on the specified [[ikiwiki/PageSpec]]. -#### `pagespec_match($$)` +#### `pagespec_match($$;@)` -Passed a page name, and a [[PageSpec]], returns true if the [[PageSpec]] -matches the page. +Passed a page name, and [[ikiwiki/PageSpec]], returns true if the +[[ikiwiki/PageSpec]] matches the page. + +Additional named parameters can be passed, to further limit the match. +The most often used is "location", which specifies the location the +PageSpec should match against. If not passed, relative PageSpecs will match +relative to the top of the wiki. #### `bestlink($$)` @@ -416,9 +447,9 @@ Given a page and the text of a link on the page, determine which existing page that link best points to. Prefers pages under a subdirectory with the same name as the source page, failing that goes down the directory tree to the base looking for matching -pages, as described in [[SubPage/LinkingRules]]. +pages, as described in [[ikiwiki/SubPage/LinkingRules]]. -#### `htmllink($$$;$$$)` +#### `htmllink($$$;@)` Many plugins need to generate html links and add them to a page. This is done by using the `htmllink` function. The usual way to call @@ -435,11 +466,15 @@ Here `$destpage` is the inlining page. A `destpage` parameter is passed to some of the hook functions above; the ones that are not passed it are not used during inlining and don't need to worry about this issue. -The remaining three optional parameters to `htmllink` are: +After the three required parameters, named parameters can be used to +control some options. These are: -1. noimageinline - set to true to avoid turning links into inline html images -1. forcesubpage - set to force a link to a subpage -1. linktext - set to force the link text to something +* noimageinline - set to true to avoid turning links into inline html images +* forcesubpage - set to force a link to a subpage +* linktext - set to force the link text to something +* anchor - set to make the link include an anchor +* rel - set to add a rel attribute to the link +* class - set to add a css class to the link #### `readfile($;$)` @@ -450,24 +485,39 @@ in binary mode. A failure to read the file will result in it dying with an error. -#### `writefile($$$;$)` +#### `writefile($$$;$$)` Given a filename, a directory to put it in, and the file's content, writes a file. -The optional second parameter, if set to a true value, makes the file be +The optional fourth parameter, if set to a true value, makes the file be written in binary mode. +The optional fifth parameter can be used to pass a function reference that +will be called to handle writing to the file. The function will be called +and passed a file descriptor it should write to, and an error recovery +function it should call if the writing fails. (You will not normally need to +use this interface.) + A failure to write the file will result in it dying with an error. If the destination directory doesn't exist, it will first be created. -### `will_render($$)` +#### `will_render($$)` Given a page name and a destination file name (not including the base destination directory), register that the page will result in that file -being rendered. It's important to call this before writing to any file in -the destination directory. +being rendered. + +It's important to call this before writing to any file in the destination +directory, and it's important to call it consistently every time, even if +the file isn't really written this time -- unless you delete any old +version of the file. In particular, in preview mode, this should still be +called even if the file isn't going to be written to during the preview. + +Ikiwiki uses this information to automatically clean up rendered files when +the page that rendered them goes away or is changed to no longer render +them. will_render also does a few important security checks. #### `pagetype($)` @@ -479,24 +529,78 @@ a type that ikiwiki knowns how to htmlize. Otherwise, returns undef. Given the name of a source file, returns the name of the wiki page that corresponds to that file. -#### `srcfile($)` +#### `srcfile($;$)` Given the name of a source file in the wiki, searches for the file in -the source directory and the underlay directory, and returns the full -path to the first file found. +the source directory and the underlay directories (most recently added +underlays first), and returns the full path to the first file found. + +Normally srcfile will fail with an error message if the source file cannot +be found. The second parameter can be set to a true value to make it return +undef instead. + +#### `add_underlay($)` + +Adds a directory to the set of underlay directories that ikiwiki will +search for files. -#### `displaytime($)` +If the directory name is not absolute, ikiwiki will assume it is in +the parent directory of the configured underlaydir. + +#### `displaytime($;$)` Given a time, formats it for display. +The optional second parameter is a strftime format to use to format the +time. + +#### `gettext` + +This is the standard gettext function, although slightly optimised. + +#### `urlto($$)` + +Construct a relative url to the first parameter from the page named by the +second. The first parameter can be either a page name, or some other +destination file, as registered by `will_render`. + +#### `targetpage($$)` + +Passed a page and an extension, returns the filename that page will be +rendered to. + +## Internal use pages + +Sometimes it's useful to put pages in the wiki without the overhead of +having them be rendered to individual html files. Such internal use pages +are collected together to form the RecentChanges page, for example. + +To make an internal use page, register a filename extension that starts +with "_". Internal use pages cannot be edited with the web interface, +generally shouldn't contain wikilinks or preprocessor directives (use +either on them with extreme caution), and are not matched by regular +PageSpecs glob patterns, but instead only by a special `internal()` +[[ikiwiki/PageSpec]]. + ## RCS plugins -ikiwiki's support for revision control systems also uses pluggable perl -modules. These are in the `IkiWiki::RCS` namespace, for example +ikiwiki's support for [[revision_control_systems|rcs]] also uses pluggable +perl modules. These are in the `IkiWiki::RCS` namespace, for example `IkiWiki::RCS::svn`. -Each RCS plugin must support all the IkiWiki::rcs\_* functions. +Each RCS plugin must support all the `IkiWiki::rcs_*` functions. See IkiWiki::RCS::Stub for the full list of functions. It's ok if -rcs\_getctime does nothing except for throwing an error. +`rcs_getctime` does nothing except for throwing an error. + +See [[RCS_details|rcs/details]] for some more info. + +## PageSpec plugins -See [[about_RCS_backends]] for some more info. +It's also possible to write plugins that add new functions to +[[PageSpecs|ikiwiki/PageSpec]]. Such a plugin should add a function to the +IkiWiki::PageSpec package, that is named `match_foo`, where "foo()" is +how it will be accessed in a [[ikiwiki/PageSpec]]. The function will be passed +two parameters: The name of the page being matched, and the thing to match +against. It may also be passed additional, named parameters. It should return +a IkiWiki::SuccessReason object if the match succeeds, or an +IkiWiki::FailReason object if the match fails.