Crowdsourcing Translations/Developer Documentation - Revision history

Bttalic at 09:20, 20 September 2013

2013-09-20T09:20:23Z

Bttalic at 03:58, 20 September 2013

2013-09-20T03:58:27Z

Bttalic at 03:57, 20 September 2013

2013-09-20T03:57:24Z

Bttalic at 03:48, 20 September 2013

2013-09-20T03:48:12Z

Bttalic: /* Function extract_metadata */

2013-09-20T03:11:17Z

‎Function extract_metadata

Bttalic at 03:10, 20 September 2013

2013-09-20T03:10:25Z

Bttalic at 02:59, 20 September 2013

2013-09-20T02:59:03Z

Bttalic at 02:45, 20 September 2013

2013-09-20T02:45:12Z

Bttalic at 02:37, 20 September 2013

2013-09-20T02:37:00Z

Bttalic at 02:26, 20 September 2013

2013-09-20T02:26:19Z

← Older revision		Revision as of 09:20, 20 September 2013
Line 1,205:		Line 1,205:
	* [http://project.geeklog.net/cgi-bin/hgwebdir.cgi/gsoc-2013-btalic/summary, Repository]		* [http://project.geeklog.net/cgi-bin/hgwebdir.cgi/gsoc-2013-btalic/summary, Repository]
	* [http://wiki.geeklog.net/index.php?title=Crowdsourcing_Translations, User documentation]		* [http://wiki.geeklog.net/index.php?title=Crowdsourcing_Translations, User documentation]
		+
		+	[[Category:Development]] [[Category:Summer of Code]]

← Older revision		Revision as of 03:58, 20 September 2013
Line 1,198:		Line 1,198:

	* Ideally, translators should be able to see the text strings in context to help with the translation. - implemented		* Ideally, translators should be able to see the text strings in context to help with the translation. - implemented
−	** If that turns out not to be possible, we'll show them without context.
	* It's acceptable if the translation option slows things down. If it slows down things noticably, add a "translation mode", so users can decide between using the site normally or helping with the translation. - not necessary		* It's acceptable if the translation option slows things down. If it slows down things noticably, add a "translation mode", so users can decide between using the site normally or helping with the translation. - not necessary

@@ Line 1,127: / Line 1,127: @@
 ! Parameters summary
 |-
-||array|| peer_name||		The string we are searching for
+||string|| peer_name||		The string we are searching for
 |}
 == Considerations ==

← Older revision		Revision as of 03:48, 20 September 2013
Line 994:		Line 994:

	==JavaScript Documentation==		==JavaScript Documentation==
		+	===public_html/crowdtranslator===
		+	====string_extract.js====
		+
		+	=====Members=====
		+	language_strings
		+
		+	=====Function add_autocomplete_to_language_input=====
		+	Gets list of available languages for translation via AJAX call
		+	and uses jQueryUI to create auto-complete option for the language selection input
		+
		+	=====Function add_notification=====
		+	Adds notification to side view if awards have been given
		+	{\| class="wikitable"
		+	\|-
		+	! Parameters summary
		+	\|-
		+	\|\|int\|\| awards\|\| award number of awards given
		+	\|}
		+
		+	=====Function add_peer=====
		+	Does a AJAX call to lib-translator.php a new peer is created
		+
		+	=====Function block_user=====
		+	Issuing AJAX call to put a user on the block list
		+
		+	=====Function del_cookie=====
		+	Deletes a cookie, it is used to delete the selected_language cookie
		+
		+
		+	=====Function delete_translation=====
		+	Issuing AJAX call to delete a translation from the database
		+	{\| class="wikitable"
		+	\|-
		+	! Parameters summary
		+	\|-
		+	\|\|int\|\| id\|\| The translation id
		+	\|-
		+	\|\|string\|\| translation\|\| the translation text
		+	\|}
		+
		+
		+	=====Function doSearch=====
		+	The function finds the searched text and highlights it
		+	{\| class="wikitable"
		+	\|-
		+	! Parameters summary
		+	\|-
		+	\|\|string\|\| text\|\| The string we are searching for
		+	\|-
		+	\|\|string\|\| value\|\| The value, either color or inherit
		+	\|}
		+
		+	=====Function getCookie=====
		+	Gets the script saved cookie
		+	{\| class="wikitable"
		+	\|-
		+	! Parameters summary
		+	\|-
		+	\|\|string\|\| c_name\|\| Name of the cookie
		+	\|}
		+
		+	=====Function get_all_badges=====
		+	Issues AJAX call to display all available badges
		+	{\| class="wikitable"
		+	\|-
		+	! Parameters summary
		+	\|-
		+	\|\|int\|\| admin\|\| Indicating if showing all badges awarded to a user or all badges available
		+	\|}
		+
		+
		+	=====Function get_base_url=====
		+	Creates the base url for AJAX calls and resource retrieval (e.g. images)
		+
		+	=====Function get_original_language_values=====
		+	Sends a AJAX request to get formatted LANG strings and the actual translation form
		+
		+	=====Function getCookie=====
		+	Gets the script saved cookie
		+
		+	=====Function hide_guidelines=====
		+	Hides guidelines for translator usage
		+
		+	=====Function hide_language_input=====
		+	if a language for translation if picked by the user the form is hidden
		+
		+	=====Function mark_bad_inputs=====
		+	Adds a css class to faulty inputs so they are easily recognizable, Gives a preview of those at the beginning of the form
		+	{\| class="wikitable"
		+	\|-
		+	! Parameters summary
		+	\|-
		+	\|\|array\|\| bad_inputs\|\| array of numbers marking the input id of the faulty inputs
		+	\|}
		+
		+	=====Function pack_translation=====
		+	Does the AJAX call to pack_translation.php which will do the actual translation packing
		+	{\| class="wikitable"
		+	\|-
		+	! Parameters summary
		+	\|-
		+	\|\|string\|\| language\|\| the language name which should be packed
		+	\|}
		+
		+	=====Function highlight=====
		+	adds CSS class to highlight selected string(s) on page
		+
		+
		+	=====Function prep_doSearch=====
		+	Prepares the search removing and from passed strings
		+	{\| class="wikitable"
		+	\|-
		+	! Parameters summary
		+	\|-
		+	\|\|string\|\| text\|\| The string we are searching for
		+	\|-
		+	\|\|string\|\| value\|\| The value, either color or inherit
		+	\|}
		+
		+	=====Function remove_block=====
		+	Issuing AJAX call to remove a user from the block list
		+
		+
		+	=====Function remove_highlight=====
		+	removes CSS class of highlighted string(s) on page
		+
		+
		+	=====Function remove_peer=====
		+	Does a AJAX call to lib-translator.php a peer is deleted
		+	{\| class="wikitable"
		+	\|-
		+	! Parameters summary
		+	\|-
		+	\|\|array\|\| peer_name\|\| The string we are searching for
		+	\|}
		+

@@ Line 928: / Line 928: @@
 |-
 ||string metadata passed on via POST
 |-
 ||string|| language_array|| empty - the value will be extracted from the metadata string

← Older revision		Revision as of 03:10, 20 September 2013
Line 922:		Line 922:

	====recieve_remote.php====		====recieve_remote.php====
		+	=====Function extract_metadata=====
		+	{\| class="wikitable"
		+	\|-
		+	! Parameters summary
		+	\|-
		+	\|\|string metadata passed on via POST
		+	\|-
		+	\|\|string\|\| language_array\|\| empty - the value will be extracted from the metadata string
		+	\|-
		+	\|\|string\|\| language_array\|\| empty - the value will be extracted from the metadata string
		+	\|}
		+
		+	=====Function save_to_database=====
		+	{\| class="wikitable"
		+	\|-
		+	!Parameters summary
		+	\|-
		+	\|\|array\|\| $process_q\|\| process_q array of objects/translations to be saved to the database
		+	\|}
		+
		+
		+	===public_html/admin/crowdtranslator===
		+	====send_remote.php====
		+	=====Function add_remote_form_element=====
		+
		+	{\| class="wikitable"
		+	\|-
		+	! Parameters summary
		+	\|-
		+	\|\|string\|\| &$form\|\| The HTML of the translation form
		+	\|-
		+	\|\|integer\|\| $count\|\| number of current input field
		+	\|-
		+	\|\|object\|\| $value\|\| current translation object, holds all relevant data for the string
		+	\|-
		+	\|\|string\|\| $base_url\|\| base url for the required resources
		+	\|-
		+	\|\|string\|\| $disabled_up\|\| Will either be empty string or disable if the vote button should be disabled
		+	\|-
		+	\|\|string\|\| $disabled_down\|\| Will either be empty string or disable if the vote button should be disabled
		+	\|}
		+
		+	=====Function credentials_form=====
		+	Generates the form for submiting translations to a remote web page
		+	{\| class="wikitable"
		+	\|-
		+	!Return value summary
		+	\|-
		+	\|\|string\|\| HTML code for the form
		+	\|}
		+
		+	=====Function get_peer_list=====
		+	Get the list of sites allowed to submit translations
		+	{\| class="wikitable"
		+	\|-
		+	!Return value summary
		+	\|-
		+	\|\|string\|\| HTML code for the list
		+	\|}
		+
		+	=====Function get_remote_language_array=====
		+	Generates an array of objects holding translations and their metadata
		+
		+	{\| class="wikitable"
		+	\|-
		+	! Return value summary
		+	\|-
		+	\|\|array\|\| Objects holding translations and their metadata
		+	\|}
		+
		+

@@ Line 822: / Line 822: @@
 |-
 !Return value summary
 ||string||	 JSON encoded string with failure or success message
 |}
 ====packing.php====
 ====recieve_remote.php====

@@ Line 743: / Line 743: @@
 |-
 ||integer|| returns	 number of votes casted by current user
 |}

@@ Line 448: / Line 448: @@
 ! Return value summary
 |-
-||integer	 biggest number of up votes for single translation
+||integer||	 biggest number of up votes for single translation
 |}
@@ Line 602: / Line 602: @@
 ! Return value summary
 |-
-||string	 HTML code of the table
+||string||	 HTML code of the table
 |}
@@ Line 629: / Line 629: @@
 ! Return value summary
 |-
-||string	 display HTML code of the last table row which includes the click for Previous show, Next show and input box for limit
+||string||	 display HTML code of the last table row which includes the click for Previous show, Next show and input box for limit
 |}

@@ Line 435: / Line 435: @@
 =====Function get_most_upvotes=====
-Returns translation with the most upvotes
+Returns translation with the most up votes
 {| class="wikitable"
@@ Line 448: / Line 448: @@
 ! Return value summary
 |-
-||integer	 bigest number of upvotes for single translation
+||integer	 biggest number of up votes for single translation
 |}
@@ Line 492: / Line 492: @@
 |}
-Function get_subindex
+=====Function get_subindex=====
 Returns the array sub-index from the metadata string
@@ Line 512: / Line 512: @@
 ||string||	 array sub-index
 |}