search

fedwiki / wiki-server

Federated Wiki client and server in Node.js
Other
153 stars 35 forks source link

How to design new plugin: principles and steps to follow #44

Closed espinielli closed 10 years ago

espinielli commented 10 years ago

I would be interested to (try to) design a new plugin, allow a page to act as a Literate Wiki. I had a look at existing plugins code but I would really appreciate an introduction/explanation about design principles of the current design, i.e. what/why/when server.coffee, what is the pages directory and how to generate it at plugin "bootstrap" time, how to deal with a development wiki, how to enable all existing plugins (there are plenty of them in the codebase but only few seems available in deployed fedwikis)...thanks

WardCunningham commented 10 years ago

I assume you are referring to Literate Programming as it might be realized in a wiki. This is a great idea. Just the thought of it got me reminiscing about my own experiment translating the original wiki script to HyperPerl.

http://code.fed.wiki.org/hyperperl.html

More to your question. Now that I am writing, I will attempt to answer your more general questions in a new wiki created for this very purpose. Thanks for prompting this work.

http://plugins.fed.wiki.org/about-plugins.html

Finally, the ReadMe for this repo should have basic build instructions that explain how the parts come together to make a finished wiki. This itself is changing as we break the federated wiki project into separate parts. Regretfully the work is unfinished and the documentation lags the work. I happily share my own working notes.

http://ward.fed.wiki.org/release-process.html

espinielli commented 10 years ago

I tried to write my idea in a (federated) wiki ;-) http://wiki-espin.rhcloud.com/view/welcome-visitors/view/literate-wiki

WardCunningham commented 10 years ago

I added some comments. If you fork it back then we're connected. http://wiki-espin.rhcloud.com/view/welcome-visitors/ward.fed.wiki.org/literate-wiki