MPR FAQ go

You can get to the demo by clicking on "Your Local MPR" or on the "go" near "MPR FAQ".

What is MPR?

It stands for MooTools Plugin Repository and aims at helping developers to use and create MPR Plugins.

What is a MPR Plugin?

Basically it's a bunch of files named and ordered in a specific way so it can easil integrated. A typical MPR Plugin contains:
  • Javascript Files
  • Documentation Files (Markdown)
  • Demo Files
  • Resources (Css, Images...)
  • Specs

Do I need a dokumentation for my MPR Plugin?

No, you don't need to add a doku but you should as it will help other and it's searchable.

Do I need a demo for my MPR Plugin?

No, but people really like demos. And it's really easy to learn from them.

Why should I publish my MooTools Plugin with MPR and not on my own?

I believe it's problematic that everyone is publishing in his own way as it's alwas different. Finding the nessesary CSS, JS, Image files is always hard. Furthermore the dokumentation and demos are always completely different and you need to bookmark (and find them if needed) seperately. With MPR everything is always in ONE place. You have the demos, the docs... in similiar manner and you can even search through all your locally installed plugins. And one of the best parts - Your Plugins can resists on other Plugins without the need to maintain the "original" Plugin. Once a Plugin is inside MPR you easily integrate it into your Plugin and you don't have to care about these dependences.

Howto install a MPR Plugin?

Installing a MPR Plugin is really easy. Just download a MPR Plugin as zip file and place it in "Mpr/MprZip/" [can be configured differently]. Then go to the MPR General Admin hit the install button and you can explore the new demos/docus...

Howto create a MPR Plugin?

If you have a Plugin inside MPR you find this little icon beside it to download it - just distribute it instead of the single files. As a start you can look at the MprDummyPlugin or you can download it directly as zip.

Enough already - I wanna try it...

Just click on top at "Your Local MPR" - there you see what it will look like once you installed it at home... :p

Enough already - I wanna have it!

You can download the latest version at github where you can also get a zip file of it (click on the download button at the top).

Requirements

You need an server with php support. (no database)

More detail on the Installation

1) make it display something: download -> extract -> set rights (easiers: chmod 777 Mpr/MprCache Mpr/MprZip Mpr/MprIndex) [folders would be created automatically]
2) use it: create a file called "USE_ADMIN_FUNCTIONS" in the root folder (it can/should be empt) [if you don't do this you can't use admin functions]
3) use the Search: General Admin -> Recreate Search Index

Change the Config

If you want to change something like the Zip/Cache or whatever path take a look at Mpr/Php/MprConfig.php for available options. Now create a MprConfig.php in the root folder and "override" what you want. my "local" Config usually just resists of $MprOptions['useCache'] = false; so I can develop without cache.

I don't have PHP...

Well than a local installation of MPR won't work for you. But you can still use the convention for a MPR Plugin. Maybe we get some ports of MprJs.php and MprCss.php...

ok I got a MPR Plugin and I want to include it into the "offical" MPR

good to go :) Well there is currently no "Server" implementation where you could register and upload your plugins with commenting and bug reporting and so on... However you can just post a zip at mooforum.net or send them to me and I would be more than happy to integrate it into this current "demo".

Endnote

the "used" PHP code is far from beeing nice.. but hey it works and if you want to help to improve it - hell yeah I like teamwork... :p