Contribute.Documentation History

Hide minor edits - Show changes to markup

October 10, 2011, at 03:25 PM by ban - Update instruction for Git
Changed lines 12-16 from:

Check out current documentation from SVN

The documentation is included in the source distribution. Thus, most current documentation is available in Geany's SVN repository. To make sure you have the most recent version, check out the trunk tree of Geany as described on the SVN page and then cd geany/doc.

If you don't like to have the whole Geany sources on your disk, you can also just check out the doc directory, but note that any make command mentioned below will not work as expected then and you will have to work with rst2html and/or rst2pdf directly then.
to:

Check out current documentation from Git

The documentation is included in the source distribution. Thus, most current documentation is available in Geany's Git repository. To make sure you have the most recent version, check out the master branch of Geany as described on the Git page and then cd geany/doc.

Changed lines 19-23 from:

After you are happy with your changes, create a patch:

% svn diff geany.txt > foo.patch

and submit that file to the Geany-devel mailing list for review.

to:

After you are happy with your changes, create a patch. First, commit your changes, making sure to write a sensible commit message:

% git commit -a

And then export the patch to a file:

% git format-patch HEAD^

This will create a patch file named after the commit message.

Finally, submit that file to the Geany-devel mailing list for review.

February 17, 2010, at 10:47 PM by dmaphy - add note about make commands which may not work when just checking out the doc/ directory
Changed lines 13-14 from:

The documentation is included in the source distribution. Thus, most current documentation is available in Geany's SVN repository. To make sure you have the most recent version, check out the trunk tree of Geany as described on the SVN page and then cd geany/doc. If you don't like to have the whole Geany sources on your disk, you can also just check out the doc directory.

to:

The documentation is included in the source distribution. Thus, most current documentation is available in Geany's SVN repository. To make sure you have the most recent version, check out the trunk tree of Geany as described on the SVN page and then cd geany/doc.

If you don't like to have the whole Geany sources on your disk, you can also just check out the doc directory, but note that any make command mentioned below will not work as expected then and you will have to work with rst2html and/or rst2pdf directly then.
February 16, 2010, at 07:54 PM by dmaphy - Apply Lex's changes
Changed lines 1-3 from:

Introduce yourself as author

Subscribe to the Geany-devel mailing list and write a short mail to the list so that everyone knows you are there and like to contribute as author for the documentation.

to:

Introduce yourself as an author

Subscribe to the Geany-devel mailing list and write a short mail to the list so that everyone knows you are there, and would like to contribute as an author for the documentation.

Changed line 5 from:

Note that you will need several tools installed on your system. In special these are:

to:

Note that you will need several tools installed on your system. In particular these are:

Changed lines 13-14 from:

The documentation is included in the source distribution. Thus, most current documentation is available in Geany's SVN repository. To make sure you have the most recent version, check out the trunk tree of Geany as described on the SVN page and then cd geany/doc.

to:

The documentation is included in the source distribution. Thus, most current documentation is available in Geany's SVN repository. To make sure you have the most recent version, check out the trunk tree of Geany as described on the SVN page and then cd geany/doc. If you don't like to have the whole Geany sources on your disk, you can also just check out the doc directory.

Changed lines 16-17 from:

You will find a file called geany.txt there which is the basis of all documentation. It is written in reStructuredText (or "reST"). Feel free to improve this file as you like. To build the related HTML document to see how your changes look like, run "make doc" in the doc directory. This regenerates the geany.html file. To generate a PDF file, use the command "make pdf" which generates a file called geany-{version}.pdf.

to:

You will find a file called geany.txt, which is the basis of all documentation. It is written in reStructuredText (or "reST"). Feel free to improve this file as you like. To build the related HTML document to see what your changes look like, run "make doc" in the doc directory. This regenerates the geany.html file. To generate a PDF file, use the command "make pdf" which generates a file called geany-{version}.pdf.

February 15, 2010, at 08:29 PM by enrico - Minor fixes
Changed lines 13-14 from:

The documentation is included in any source distribution. Thus, most current documentation is available in Geanys SVN repository. To make sure you have the most current version, check out the trunk tree of Geany as described on the SVN page and then cd geany/doc.

to:

The documentation is included in the source distribution. Thus, most current documentation is available in Geany's SVN repository. To make sure you have the most recent version, check out the trunk tree of Geany as described on the SVN page and then cd geany/doc.

Changed line 23 from:

and submit that file to the mailing list for review.

to:

and submit that file to the Geany-devel mailing list for review.

February 15, 2010, at 08:08 PM by dmaphy - correct mailing list links
Changed lines 2-3 from:

Subscribe to the MailingList#Geany-devel and write a short mail to the list so that everyone knows you are there and like to contribute as author for the documentation.

to:

Subscribe to the Geany-devel mailing list and write a short mail to the list so that everyone knows you are there and like to contribute as author for the documentation.

February 15, 2010, at 08:04 PM by dmaphy - correct the mailing list link a second time
Changed line 23 from:

and submit that file to the MailingList for review.

to:

and submit that file to the mailing list for review.

February 15, 2010, at 08:03 PM by dmaphy - correct the mailing list link
Changed line 23 from:

and submit that file to the mailing list? for review.

to:

and submit that file to the MailingList for review.

February 15, 2010, at 08:03 PM by dmaphy - create this page
Added lines 1-23:

Introduce yourself as author

Subscribe to the MailingList#Geany-devel and write a short mail to the list so that everyone knows you are there and like to contribute as author for the documentation.

Prepare for your work

Note that you will need several tools installed on your system. In special these are:

  • Subversion
  • Python docutils

The packages are named subversion and python-docutils on Debian and Fedora systems.

Writing Documentation

Check out current documentation from SVN

The documentation is included in any source distribution. Thus, most current documentation is available in Geanys SVN repository. To make sure you have the most current version, check out the trunk tree of Geany as described on the SVN page and then cd geany/doc.

Edit geany.txt

You will find a file called geany.txt there which is the basis of all documentation. It is written in reStructuredText (or "reST"). Feel free to improve this file as you like. To build the related HTML document to see how your changes look like, run "make doc" in the doc directory. This regenerates the geany.html file. To generate a PDF file, use the command "make pdf" which generates a file called geany-{version}.pdf.

Create a patch and send it to us

After you are happy with your changes, create a patch:

% svn diff geany.txt > foo.patch

and submit that file to the mailing list? for review.