Main Page
From MediaWiki Publisher
Welcome to the MediaWiki Publisher Project
MediaWiki Publisher (MWP) is a simple, easy to use tool for automating the task of publishing documentation or information maintained by multiple authors inside any installation of MediaWiki. It can be used to export full articles (including images and link information) to multiple markup formats, and is released under the GNU GPL.
Currently, the only supported formats are browsable XHTML, and HelpBlocks project files (for generating Windows CHM and cross-platform help formats), however, MWP sports a full API (written in PHP) for writing up additional formats in as little as 100 lines of code depending on how much customization is needed.
The project documentation is maintained on this wiki, and serves as an excellent example of what's possible with MediaWiki Publisher. Samples of exported docs including the MWP User Manual are listed on the Parser Previews page.
Getting StartedMWP requires at least a minimal knowledge of PHP even for simple use. So if you aren't familiar with the language, it's recommended that you start yourself off on a few PHP tutorials. If you just plan on using existing MWP parsers, you will only need to touch the config.php file. Writing your own parser does require a good knowledge of how abstract classes work in PHP and how to override base class functionality. You may want to check that you meet the minimum requirements before downloading MWP. Once downloaded, you can jump into the Installation & Configuration section of the User Manual which will get you on your way to automated generation of your content. If you run into any problems, you can find support on the mailing list. You may also want to sign yourself up on the mailing list for notification of new releases. Those wishing to write your own parsers will want first read up on the Writing Custom Parsers section of the manual as soon as it's written up. In the mean time though, make yourself familiar with the code, specifically the classes mentioned in the contents of the user manual. You will find that the mailing list will come in extremely handy as well. |
DownloadThere hasn't been an official release just yet, however, you can download a snapshot of the latest development version. |
