Wiki gloss extension - Revision history

Jessica at 00:30, 24 March 2012

2012-03-24T00:30:25Z

← Older revision		Revision as of 00:30, 24 March 2012
Line 133:		Line 133:
	</pre>		</pre>

	~~== IPA fonts ==~~

	~~In general~~, ~~IPA~~ fonts should ~~work fine in~~ the gloss ~~extension~~.		== Known issues ==

			=== Unicode string handling ===
			While the GL extension does handle unicode characters, there are some instances where it will incorrectly align strings containing rich unicode characters. While the fonts should look okay, when using these characters, the phrase and gloss may not perfectly line up.


	<gl id="ex7">		<gl id="ex7">
Line 142:		Line 145:
	\trans these aren't real words.		\trans these aren't real words.
	</gl>		</gl>

	~~== Known issues ==~~

	~~=== Unicode string handling ===~~
	While the GL extension does handle unicode characters, there are some instances where it will incorrectly align strings containings rich unicode characters. When using these characters, the phrase and gloss may not perfectly line up.

	=== Formatting within GL blocks ===		=== Formatting within GL blocks ===
	Currently, it is impossible to use special formatting (e.g. boldface, italics) inside a GL block.		Currently, it is impossible to use special formatting (e.g. boldface, italics) inside a GL block.

Jessica: /* IPA fonts */

2012-03-24T00:27:11Z

IPA fonts

← Older revision		Revision as of 00:27, 24 March 2012
Line 138:		Line 138:

	<gl id="ex7">		<gl id="ex7">
	\gll ~~ɮɬʊʌɯɲɟ~~ ʉɤɰɭɮɸ ʊɛæʔɦð o͌ʩʬΘ˔ʙ		\gll lɮɬʊʌɯɲɟ ʉɤɰɭɮɸ ʊɛæʔɦð o͌ʩʬΘ˔ʙ
	look at these fonts!		look at these fonts!
	\trans these aren't real words.		\trans these aren't real words.

Jessica at 00:26, 24 March 2012

2012-03-24T00:26:49Z

@@ Line 132: / Line 132: @@
 </gl>
 </pre>
 == Known issues ==

Jessica at 20:07, 18 March 2012

2012-03-18T20:07:14Z

← Older revision		Revision as of 20:07, 18 March 2012
Line 7:		Line 7:

	1. Download and unzip the gloss.php file [http://people.linguistics.mcgill.ca/~jessica/Welcome_files/gloss.zip here]		1. Download and unzip the gloss.php file [http://people.linguistics.mcgill.ca/~jessica/Welcome_files/gloss.zip here]

	2. Copy the ''gloss.php'' file into the ''includes'' directory of your MediaWiki installation		2. Copy the ''gloss.php'' file into the ''includes'' directory of your MediaWiki installation
	3. Open the ''LocalSettings.php'' file in the root directory of your MediaWiki installation. Just below the line <pre>require_once( "$IP/includes/DefaultSettings.php" );</pre> add the line <pre>require_once( "$IP/includes/gloss.php" );</pre>		3. Open the ''LocalSettings.php'' file in the root directory of your MediaWiki installation. Just below the line <pre>require_once( "$IP/includes/DefaultSettings.php" );</pre> add the line <pre>require_once( "$IP/includes/gloss.php" );</pre>

Jessica at 20:06, 18 March 2012

2012-03-18T20:06:40Z

← Older revision		Revision as of 20:06, 18 March 2012
Line 5:		Line 5:
	= Installing the extension =		= Installing the extension =
	To install the extension, you must have access to the ''includes'' directory of your MediaWiki installation. The installation is a two step procedure.		To install the extension, you must have access to the ''includes'' directory of your MediaWiki installation. The installation is a two step procedure.

	1. Copy the ''gloss.php'' file into the ''includes'' directory of your MediaWiki installation		1. Download and unzip the gloss.php file [http://people.linguistics.mcgill.ca/~jessica/Welcome_files/gloss.zip here]
	2. Open the ''LocalSettings.php'' file in the root directory of your MediaWiki installation. Just below the line <pre>require_once( "$IP/includes/DefaultSettings.php" );</pre> add the line <pre>require_once( "$IP/includes/gloss.php" );</pre>		2. Copy the ''gloss.php'' file into the ''includes'' directory of your MediaWiki installation
			3. Open the ''LocalSettings.php'' file in the root directory of your MediaWiki installation. Just below the line <pre>require_once( "$IP/includes/DefaultSettings.php" );</pre> add the line <pre>require_once( "$IP/includes/gloss.php" );</pre>

	You should now be able to use the Gloss extension in your wiki pages.		You should now be able to use the Gloss extension in your wiki pages.

Jessica: Created page with "
TOC
= Overview = The Gloss extension provides a wiki markup element for linguistic annotations, developed for M..."

2012-02-20T01:29:06Z

Created page with "<div style="float:right; clear:both; margin-left:0.5em;">__TOC__</div> = Overview = The Gloss extension provides a wiki markup element for linguistic annotations, developed for M..."

New page

<div style="float:right; clear:both; margin-left:0.5em;">__TOC__</div>
= Overview =
The Gloss extension provides a wiki markup element for linguistic annotations, developed for McGill Field Methods classes by [http://www.ruthsresearch.org/ Derek Ruths]. The Gloss extension automatically aligns text with glosses, as well as provides auto-numbering and hyper-referencing. It closely follows the form and features of the [http://www.essex.ac.uk/linguistics/external/clmt/latex4ling/ Latex-based glossing tools], allowing the wiki source text to be easily pasted into Latex documents. This page provides both formal documentation of the extension as well as numerous examples of how the tool is used.

= Installing the extension =
To install the extension, you must have access to the ''includes'' directory of your MediaWiki installation. The installation is a two step procedure.

1. Copy the ''gloss.php'' file into the ''includes'' directory of your MediaWiki installation
2. Open the ''LocalSettings.php'' file in the root directory of your MediaWiki installation. Just below the line <pre>require_once( "$IP/includes/DefaultSettings.php" );</pre> add the line <pre>require_once( "$IP/includes/gloss.php" );</pre>

You should now be able to use the Gloss extension in your wiki pages.

= Using the extension =

== The GL element ==
The Gloss extension allows a wiki editor to automatically align text for interlinear glossing. In this extension, one phrase-gloss-translation entry is entered inside an xml-formatted element
<pre>
<gl ...arguments...>
\gll ...text...
...gloss...
\trans ...translation...
</gl>
</pre>
A simple example would be
<pre>
<gl id="ex1">
\gll ela'l-ul magasan-g
bring-1>2 store-LOC
\trans I'm bringing you to the store.
</gl>
</pre>
which produces the following block:
<gl id="ex1">
\gll ela'l-ul magasan-g
bring-1>2 store-LOC
\trans I'm bringing you to the store.
</gl>

A fourth line can be added above the parsed line:

<gl id="ex2">
ela'lul magasang
\gll ela'l-ul magasan-g
bring-1>2 store-LOC
\trans I'm bringing you to the store.
</gl>

== Numbering and references ==
Notice that the example blocks above were automatically numbered. This number is inserted and auto-increments. As a result, the next block will receive the number 3.
<gl id="ex3">
\gll Piel amalga-t
Piel dance-3SG
\trans Piel dances.
</gl>
Beyond giving some structure to the blocks themselves, you can easily create hyperlinked references to specific GL elements by using the GL reference element <pre><glr id="...gl element id..."/></pre>. So, we can reference the example above using
<pre><glr id="ex3"/></pre>
which generates this: <glr id="ex2"/>.

You can reset the numbering for a given GL element by using the GL element header:
<pre>
<gl renum="true">
...
</gl>
</pre>

== Spacing ==
The number of spaces inserted between words in the GL element can be adjusted by using the parameter ''margin''. Thus, we can render the same content with different spacings (for readability, for example), as follows:

<pre>
<gl margin=2 id="ex4">
\gll Mali newti-al-asi-t
Mali one-around-move-3sg
\trans Mali wanders around alone.
</gl>
</pre>

This produces <glr id="ex4"/>, where the margin = 2 (this is the default value):
<gl margin=2 id="ex4">
\gll Mali newti-al-asi-t
Mali one-around-move-3sg
\trans Mali wanders around alone.
</gl>

In <glr id="ex5"/> the margin = 5:
<gl margin=5 id="ex5">
\gll Mali newti-al-asi-t
Mali one-around-move-3sg
\trans Mali wanders around alone.
</gl>

== Font size ==
The size of the font used inside of the GL element can be set using the parameter ''fontsize''. By default, the fontsize is 15. Here is the same content as above, rendered in font size 12.
<gl fontsize=12>
\gll Piel wenaqwie-t
Piel jump-3SG
\trans Piel jumps
</gl>

== Blank space and grammaticality marks ==

As in Latex gloss environments, curly brackets can be inserted in the gloss line in order to line up with unglossed text, such as the square brackets in <glr id="ex6"/>
<gl id="ex6">
\gll Mali magwtgp [ lpa'tuj-ewei wenju'su'n ]
Mali eat.3sg.past {} boy-POSS apple {}
\trans Mali ate the boy's apple.
</gl>

which was created with the following input:
<pre>
<gl id="ex6">
\gll Mali magwtgp [ lpa'tuj-ewei wenju'su'n ]
Mali eat.3SG.PST {} boy-POSS apple {}
\trans Mali ate the boy's apple.
</gl>
</pre>

The same can be used to mark examples as ungrammatical or infelicitous, as in <glr id="ex7"/>
<gl id="ex7">
\gll * jinm ala mesgilg
{} man that big
\trans That man is big.
</gl>

created with:
<pre>
<gl id="ex7">
\gll * jinm ala mesgilg
{} man that big
\trans That man is big.
</gl>
</pre>

== Known issues ==

=== Unicode string handling ===
While the GL extension does handle unicode characters, there are some instances where it will incorrectly align strings containings rich unicode characters. When using these characters, the phrase and gloss may not perfectly line up.

=== Formatting within GL blocks ===
Currently, it is impossible to use special formatting (e.g. boldface, italics) inside a GL block.