Translate Toolkit & Pootle spelt

spelt:development_notes

Thu, 26 Jun 2008 12:10:36 +0000

	current
Line 1:	Line 1:
	+	====== Development Notes ======

	+	On this page you will find some miscellaneous development notes that don't have a place on any of the other development-related pages. See the TODO in the project's root for more notes that would typically fit in here.
	+
	+	===== Coding Style =====
	+
	+	There is a lot to say about the style used in Spelt (mostly my personal preferences), but only a few points are made here. Inspect the code for the rest. :-)
	+
	+	==== Identifiers ====
	+
	+	The general coding style is the same as that of the rest of the Translate Toolkit: C-like identifiers (eg. ''with_underscores'') with camel-cased class names (eg. ''SomeClass''). Gtk widgets contain prefixes indicative of its type (or at least approximately). For example the name of a gtk.Button will start with ''btn_'' and the name of a gtk.Dialog (or wrapper class thereof) starts with ''dlg_''.
	+
	+	==== Spacing ====
	+
	+	Spelt was written with an indentation size of 4 spaces.
	+
	+	A blank line is left open after any indented block except cases where the indented block is very short (one or two lines) and where said block is logically part of its surrounding statements.
	+
	+	==== Alignment ====
	+
	+	In various places, where appropriate, parts of lines has been vertically aligned to improve readability. Examples are alignment on ''=''s where there are a bunch of assignments or on ''import''s for a bunch of ''from x import y'' lines.

spelt:index

Tue, 19 Aug 2008 09:23:13 +0000

1219137526		current
Line 16:		Line 16:
	See the [[installation]] page for installation instructions on POSIX or Windows systems.		See the [[installation]] page for installation instructions on POSIX or Windows systems.
	==== Preparing a Language Database ====		==== Preparing a Language Database ====
-	Note: This should only be done by the language coordinator.	+	Note: This should only be done by the language coordinator. Careful preparation is crucial, since the classification scheme will impact all of your work afterwards. Make sure that you think carefully about the word categories you choose so that you are willing to commit to them.

	Please read the comments in the example skeleton language database ([[https://translate.svn.sourceforge.net/svnroot/translate/src/trunk/spelt/share/spelt/examples/skeldb.xldb\|skeldb.xldb]]) to familiarize yourself with the structure of a language database.		Please read the comments in the example skeleton language database ([[https://translate.svn.sourceforge.net/svnroot/translate/src/trunk/spelt/share/spelt/examples/skeldb.xldb\|skeldb.xldb]]) to familiarize yourself with the structure of a language database.

-	It is important to note that only parts-of-speech cannot be added by Spelt, but has to be added by hand. Adding surface forms can be done in Spelt via the //Import wordlist...// menu option. Adding roots can be done by simply typing in a new root, selecting its part-of-speech and clicking the //Add Root// button.	+	It is important to note that only parts-of-speech cannot be added by Spelt, but has to be added by hand. They really need to be standardised before any significant work starts, and should ideally not change much afterwards. Adding surface forms can be done in Spelt via the //Import wordlist...// menu option. Adding roots can be done by simply typing in a new root, selecting its part-of-speech and clicking the //Add Root// button.

spelt:installation

Tue, 19 Aug 2008 09:43:00 +0000

1219138980		current
Line 13:		Line 13:
	The latest release is available [[http://sourceforge.net/project/showfiles.php?group_id=91920&package_id=288205\|here]]. It is self-containing, so you will not need to download or install anything else.		The latest release is available [[http://sourceforge.net/project/showfiles.php?group_id=91920&package_id=288205\|here]]. It is self-containing, so you will not need to download or install anything else.

-	If you would like to build a stand-alone Windows installer, you will also need to get:	+	If you would like to //build// a stand-alone Windows installer, you will also need to get:
	* [[http://py2exe.org\|Py2exe]]		* [[http://py2exe.org\|Py2exe]]
	* [[http://www.jrsoftware.org/isinfo.php\|InnoSetup]]		* [[http://www.jrsoftware.org/isinfo.php\|InnoSetup]]

spelt:proposed_features

Thu, 26 Jun 2008 12:13:14 +0000

	current
Line 1:	Line 1:
	+	====== Proposed Features ======

	+	This page where features for Spelt can be proposed and discussed.

spelt:testing

Thu, 26 Jun 2008 11:51:30 +0000

	current
Line 1:	Line 1:
	+	====== Testing ======
	+
	+	===== Required packages =====
	+
	+	* [[http://codespeak.net/py/dist/test.html\|py.test]]
	+
	+	===== Running the tests =====
	+
	+	To run all tests, you can simply run py.test from the ''spelt'' directory or any subdirectory if you only want to run the tests for that particular module.
	+
	+	Currently only the models have tests.

spelt:todo

Wed, 16 Jul 2008 15:36:12 +0000

1216222431		current
Line 1:		Line 1:
		+	====== TODO ======
	Also see the TODO file in the project directory for potentially different entries.		Also see the TODO file in the project directory for potentially different entries.