Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/WardCunningham/plugins
Popular and Experimental Plugins for Federated Wiki
https://github.com/WardCunningham/plugins
Last synced: 5 days ago
JSON representation
Popular and Experimental Plugins for Federated Wiki
- Host: GitHub
- URL: https://github.com/WardCunningham/plugins
- Owner: WardCunningham
- Created: 2013-11-25T02:22:35.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2014-01-26T17:06:59.000Z (almost 11 years ago)
- Last Synced: 2024-08-01T12:20:03.913Z (3 months ago)
- Language: CoffeeScript
- Size: 1.38 MB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: changes/changes.coffee
Awesome Lists containing this project
- awesome-starred - WardCunningham/plugins - Popular and Experimental Plugins for Federated Wiki (others)
README
Deprecated Repository
=====================All federated wiki plugin source code here has been moved to individual repositories in the GitHub [FedWiki](http://github.com/fedwiki) organization.
We will be developing better guidance for creating new plugins as we gain experience with the new repositiory configuration.Client Plugin development
=========================The client side plugins are written in CoffeeScript.
We check in the generated Javascript to simplify useage.If you do want to check in changes, install node v0.6.x
* On Linux download the source from [GitHub](https://github.com/joyent/node)
* On Windows get the installer from the [main node.js site](http://nodejs.org).
* On Mac you should be able to choose either.Once node is installed come back to this directory and run:
* `npm install` To install CoffeeScript, and all its dependencies.
You can now use:
* `npm start` To compile the CoffeeScript to Javascript.
* `npm test` (not defined atm)Creating a new Plugin
=====================If you create a new plugin, you will need to have a compiled Javascript file and then re-start the server, as the server detects plugins on startup.
The simplest plugin is just a single coffescript file creating a new element (PLUGINNAME), that defines an _emit_ and _bind_ function.
window.plugins.>>PLUGINNAME<< =
').text item.text
emit: (div, item) ->
wiki.log 'lists', item
pre = $('
div.append pre
bind: (div, item) ->
div.dblclick -> wiki.textEditor div, itemCoffeeScript hints
==================We recommend taking time to learn the CoffeeScript syntax and the rationale for the Javascript idioms it employs. Start here:
http://jashkenas.github.com/coffee-script/
We used a Javascript to Coffeescript converter to create the first draft of client.coffee. You may find this converter useful for importing sample codes.
http://ricostacruz.com/js2coffee/