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. [[toc levels=2]] ## Considerations 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 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 are loaded. A plugin that inserts the current time into a page, for example, will insert the build time. Also, as a compiler, ikiwiki avoids rebuilding pages unless they have changed, so a plugin that prints some random or changing thing on a page will generate a static page that won't change until ikiwiki rebuilds the page for some other reason, like the page 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. ## Types of hooks In roughly the order they are called. ### getopt hook(type => "getopt", id => "foo", call => \&getopt); This allows for plugins to perform their own processing of command-line options and so add options to the ikiwiki command line. It's called during command line processing, with @ARGV full of any options that ikiwiki was not able to process on its own. The function should process any options it can, removing them from @ARGV, and probably recording the configuration settings in %config. It should take care not to abort if it sees an option it cannot process, and should just skip over those options and leave them in @ARGV. ### checkconfig hook(type => "checkconfig", id => "foo", call => \&checkconfig); This is useful if the plugin needs to check for or modify ikiwiki's 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. ### 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. ### preprocess Adding a [[PreProcessorDirective]] is probably the most common use of a plugin. hook(type => "preprocess", id => "foo", call => \&preprocess); Replace "foo" with the command name that will be used inside brackets for the preprocessor directive. 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. 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. ### htmlize hook(type => "htmlize", id => "ext", call => \&htmlize); Runs on the raw source of a page and turns it into html. The id parameter specifies the filename extension that a file must have to be htmlized using this plugin. This is how you can add support for new and exciting markup languages to ikiwiki. The function is passed named parameters: "page" and "content" and should return the htmlized content. ### pagetemplate 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. The most common thing to do is probably to call $template->param() to add a new custom parameter to the template. ### sanitize hook(type => "sanitize", id => "foo", call => \&sanitize); Use this to implement html sanitization or anything else that needs to modify the body of a page after it has been fully converted to html. The function is passed named parameters: "page" and "content", and should return the sanitized content. ### format hook(type => "format", id => "foo", call => \&format); The difference between format and sanitize is that sanitize only acts on the page body, while format can modify the entire html page including the header and footer inserted by ikiwiki, the html document type, etc. The function is passed named parameters: "page" and "content", and should return the formatted content. ### delete hook(type => "delete", id => "foo", call => \&delete); Each time a page or pages is removed from the wiki, the referenced function is called, and passed the names of the source files that were removed. ### change hook(type => "change", id => "foo", call => \&render); Each time ikiwiki renders a change or addition (but not deletion) to the wiki, the referenced function is called, and passed the names of the source files that were rendered. ### cgi hook(type => "cgi", id => "foo", call => \&cgi); 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. ### savestate hook(type => "savestate", id => "foo", call => \&savestate); This hook is called wheneven ikiwiki normally saves its state, just before the state is saved. The function can save other state, modify values before they're saved, etc. ## Plugin interface To import the ikiwiki plugin interface: use IkiWiki '1.00'; This will import several variables and functions into your plugin's 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 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. ### %config 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. ### Other variables If your plugin needs to access data about other pages in the wiki. It can 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. Also, the %IkiWiki::version variable contains the version number for the ikiwiki program. ### Library functions #### `hook(@)` 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 will not override any existing hook with the same id. This is useful if the id can be controled by the user. #### `debug($)` Logs a debugging message. These are supressed unless verbose mode is turned on. #### `error($)` Aborts with an error message. 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(). #### `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. #### `htmlpage($)` Passed a page name, returns the base name that will be used for a the html page created from it. (Ie, it appends ".html".) #### `add_depends($$)` Makes the specified page depend on the specified [[PageSpec]]. #### `pagespec_match($$)` Passed a page name, and a [[PageSpec]], returns true if the [[PageSpec]] matches the page. #### `bestlink($$)` 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]]. #### `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 `htmlllink` is: htmllink($page, $page, $link) Why is `$page` repeated? Because if a page is inlined inside another, and a link is placed on it, the right way to make that link is actually: htmllink($page, $destpage, $link) 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: 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 #### `readfile($;$)` Given a filename, reads and returns the entire file. The optional second parameter, if set to a true value, makes the file be read in binary mode. A failure to read the file will result in it dying with an error. #### `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 written in binary mode. 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($$)` 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. #### `pagetype($)` Given the name of a source file, returns the type of page it is, if it's a type that ikiwiki knowns how to htmlize. Otherwise, returns undef. #### `pagename($)` Given the name of a source file, returns the name of the wiki page that corresponds to that file. #### `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. #### `displaytime($)` Given a time, formats it for display. ## RCS plugins ikiwiki's support for revision control systems 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. See IkiWiki::RCS::Stub for the full list of functions. It's ok if rcs\_getctime does nothing except for throwing an error. See [[about_RCS_backends]] for some more info.