Switch branches/tags
Nothing to show
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
..
Failed to load latest commit information.
404.html
README
README.html
about.html
djynn.html
downloads.html
geanylatex.html
geanylua.html
geanysendmail.html
install.html
jsonprettifier.html
licensing.html
newline-plugin.html
pynav.html
quick_open_file.html
rst2html_config.conf
rst2html_template.txt
start.html
tidy.conf
togglebars.html

README

How to get your plugin listed here
==================================

.. contents::

There are different ways to get your plugin listed here. Every possibility
ends with contacting Dominic Hopf. He is the maintainer of this website and
takes care of uploading the HTML files and including new plugins into
navigation and so on.


Note
----

If your plugin already is part of the Geany Plugins project, you should find
your plugin listed here. There is a cronjob running every night, which
updates the plugins.geany.org website with latest information from the
README files of the plugins. For this to work correctly, it is necessary
you have a README file in trunk/geany-plugins/{your plugin name}/ which is
written in restructuredText.

If the README file is there, but still not listed on the plugins.geany.org
website, make sure you gave the cronjob a chance to find your README and
wait a night before contacting Dominic to have a deeper look on the issue.


1st Way
-------

* create a file {your plugin name}.html
* edit the file manually, get inspired by the plugin sites already existing
  and keep an eye on the validity of the HTML code. It should be XHTML 1.1 -
  which is very strict.
* when your HTML file is finished, contact Dominic by mail and send him
  your file. He will do the rest for you.


2nd Way
-------

This one will only work, if you write your README file in restructuredText
as some other plugin authors do. You will need to use two tools: rst2html
and HTML Tidy. Dominic wrote some configuration files for use with those
tools. The files can be found on github at https://github.com/geany/plugins.geany.org/tree/master/content.
The result should be an almost perfect HTML file which can be
included into the plugins.geany.org website. Do this steps to generate the
file:

    rst2html --config=rst2html_config.conf README > {your plugin name}.html
    tidy -config tidy.conf {your plugin name}.html


While {your plugin name} is the actual UNIX name (lowercase!) of your plugin.
Note: There is no need for HTML headers and body and so on. Those will be
provided by the website itself. Your HTML file should just provide pure
XHTML 1.1 validating content, it will appear within the body tags on the
plugins.geany.org website.

When you're done, have a look if your HTML file looks good (get some
inspiration from already existing plugin sites) and send it to Dominic then.

Images
------

In the past it has happend that images on external sites become unavailable.
If you like to include images in your documentation we would prefer a pull-request
against the repository https://github.com/geany/plugins.geany.org. To
create a pull-request with your images please proceed as follows:

* fork the repository on github
* upload/put your image files in the folder /images/plugins/{your plugin name}
* create the pull-request

If you write HTML directly you can simply link to the image on github.
If you use restructuredText then also simply use the full URL for the image link, e.g.:

    image:: http://plugins.geany.org/images/plugins/{your plugin name}/example.png

Contact
-------

The website plugins.geany.org is currently maintained by `Dominic Hopf
<http://dominichopf.de>`_. His mail address is dmaphy@googlemail.com. If
you have any questions concerning this site, please consider to contact him
first of all. If it takes too long for an answer, feel free to kick his
butt at the `#geany <irc://chat.freenode.net/geany>`_ IRC channel on
chat.freenode.net.