Difference between revisions of "Emacs"

From Apertium
Jump to navigation Jump to search
 
(38 intermediate revisions by 2 users not shown)
Line 3: Line 3:
Info on using '''Emacs''' for Apertium-related tasks.
Info on using '''Emacs''' for Apertium-related tasks.


==Quickstart==
== dix and transfer ==
=== Quickstart for non-emacs users ===
If you just want to get emacs set up for dix editing with the minimum of hassle, here is a howto. This assumes you have emacs version '''23 or higher''' installed (but see discussion page if you're stuck with an old version). First execute (paste) the following commands in your terminal:


There is an init file in git that will give your Emacs some useful Apertium-related packages and settings, including:
mkdir -p ~/.emacs.d
* dix-mode, for XML dictionary and transfer editing
cd ~/.emacs.d
* cg-mode, for Constraint Grammar rule editing and testing
wget -O dix.el https://svn.code.sf.net/p/apertium/svn/trunk/apertium-tools/dix.el
* hfst-mode, for lexc/twol syntax highlighting
cd ..
* tab-completion
touch ~/.emacs

Then open the file ~/.emacs in an editor (like vi) and enter the following:


To get that set up, simply
<pre>
<pre>
mkdir -p ~/.emacs.d/
; Start of dix-mode setup
curl https://raw.githubusercontent.com/unhammer/dix/master/init-apertium.el > ~/.emacs.d/init-apertium.el
(add-to-list 'load-path "~/.emacs.d") ; path to the folder where you have dix.el
echo '(load "~/.emacs.d/init-apertium.el")' >> ~/.emacs.d/init.el
(autoload 'dix-mode "dix"
emacs
"dix-mode is a minor mode for editing Apertium XML dictionary files." t)
</pre>
The last line starts up Emacs, which will download the new packages since it's the first startup. (The next startups will be much faster.)


If you ever want to update your installed Emacs packages, you do <code>M-x list-packages</code>, then <code>U x</code>.
(add-to-list 'auto-mode-alist '("\\.dix\\'" . nxml-mode)) ; turn on nxml-mode for dix-files
(add-to-list 'auto-mode-alist '("\\.t[0-9]x\\'" . nxml-mode)) ; turn on nxml-mode for transfer files
(add-hook 'nxml-mode-hook ; turn on dix-mode for transfer or dix-files after nxml-mode
(lambda () (and buffer-file-name
(string-match "\\.\\(dix\\|t[0-9]x\\)$" buffer-file-name)
(dix-mode 1))))


; turn on schema-based completion with C-RET (in emacs 24 and up: M-TAB or C-M-i):
(if (boundp 'nxml-completion-hook)
(add-to-list 'nxml-completion-hook 'rng-complete)
(setq nxml-completion-hook '(rng-complete)))


The rest of this page gives some documentation of the various modes.


===Mac OS X===
; Optional, gives more handy keybindings in nxml-mode:
If you're on Mac, the built-in emacs is ancient. Don't use that. Instead, get https://emacsformacosx.com/
(setq nxml-sexp-element-flag t ; treat <e><p>...</p></e> like (e (p ...)) for C-M-f/b/k/d/u
nxml-slash-auto-complete-flag t) ; complete the element on </
(add-hook 'nxml-mode-hook (lambda () (define-key nxml-mode-map (kbd "M-D") 'nxml-backward-down-element)))


You can make an alias to start this emacs from the command line with e.g.
; Optional, lets you erase whole <b/> or comment with a single press of backspace:
<pre>alias em="open -a /Applications/Emacs.app"</pre>
(setq dix-hungry-backspace t)


(If you prefer having non-GUI emacs, change that to <code>alias em="open -a /Applications/Emacs.app -nw"</code>.)


===Validation slow?===
; The rest of this file is optional, it turns on CUA mode setup,
; which makes copy-pasting in Emacs behave more like other editors - see http://www.emacswiki.org/CuaMode
(cua-mode t)
(setq cua-auto-tabify-rectangles nil) ; Don't tabify after rectangle commands
(setq cua-keep-region-after-copy t) ; Standard Windows behaviour
</pre>


The above init-apertium.el turns on on-the-fly XML validation, which can be slow on old computers. If editing large .dix files seems too slow, try turning off one or both of the validators by putting
See also the [[Emacs#Validation_quickstart|Validation quickstart]] for auto-validation and schema-based completion.

<pre>
(add-hook 'nxml-mode-hook (lambda () (rng-validate-mode 0)) 'append)
</pre>
in your ~/.emacs.d/init.el


== XML (dix, transfer, …) editing ==
The following sections give more info on the general xml editing mode nxml, dix-mode and validation.


=== nxml-mode ===
=== nxml-mode ===
Emacs has a nice xml editing mode called
Emacs has a nice xml editing mode (included as of version 23) called
[http://www.emacswiki.org/emacs/NxmlMode nXML], with syntax highlighting, movement commands to navigate through the XML (out of, into, across elements, etc.). It also has validation, and can auto-complete using the XML schema if a schema file is available.
[http://www.emacswiki.org/emacs/NxmlMode nXML], with syntax highlighting, movement commands to navigate through the XML (out of, into, across elements, etc.). It also has validation, and can auto-complete using the XML schema if a schema file is available.


[[#Quickstart|init-apertium.el]] turns on nxml-mode for the common Apertium XML file extensions.
If your emacs doesn't turn on nxml-mode automatically when you open an xml-file, you can add the following line to your <code>~/.emacs</code> file:

<pre>
(add-to-list 'auto-mode-alist '("\\.dix\\'" . nxml-mode))
</pre>

Emacs 23 or newer includes nxml-mode, but if your version of emacs doesn't: download nxml-mode-20041004.tar.gz (or whatever the newest version is) from http://www.thaiopensource.com/download/, extract somewhere, and add the following to your <code>.emacs</code> file:

<pre>
(load "/path/to/nxml-mode-20041004/rng-auto.el") ; full path to the _file_ rng-auto.el which you just extracted
</pre>


==== keybindings ====
==== keybindings ====
init-apertium.el also turns on the variable <code>nxml-sexp-element-flag</code>, which lets you use the following handy keys:
Some very handy nxml functions don't have keybindings by default. Here are some lines for your ~/.emacs that define keys for the most useful ones:
<pre>
(setq nxml-sexp-element-flag t ; treat <e><p>...</p></e> like (e (p ...)) for C-M-f/b/k/d/u
nxml-slash-auto-complete-flag t) ; complete the element on </
(add-hook 'nxml-mode-hook (lambda () (define-key nxml-mode-map (kbd "M-D") 'nxml-backward-down-element)))
</pre>

With these in your ~/.emacs, you can use the following keys:
* '''C-M-f''' to move forward one element (e.g. from &lt;e&gt; to &lt;/e&gt;)
* '''C-M-f''' to move forward one element (e.g. from &lt;e&gt; to &lt;/e&gt;)
* '''C-M-b''' to move backward one element (e.g. from &lt;/e&gt; to &lt;e&gt;)
* '''C-M-b''' to move backward one element (e.g. from &lt;/e&gt; to &lt;e&gt;)
Line 85: Line 58:
* '''C-M-u''' to move out of one element (e.g. from &lt;p&gt; to &lt;e&gt;)
* '''C-M-u''' to move out of one element (e.g. from &lt;p&gt; to &lt;e&gt;)
* '''C-M-k''' to kill (cut) one element
* '''C-M-k''' to kill (cut) one element
and <code>nxml-slash-auto-complete-flag</code> which lets you type
* '''&lt;/''' to write the end tag of whatever element you're in (e.g. after typing &lt;e&gt;&lt;p&gt;…&lt;/p&gt;&lt/, it'll complete with e&gt;)
* '''&lt;/''' to write the end tag of whatever element you're in (e.g. after typing &lt;e&gt;&lt;p&gt;…&lt;/p&gt;&lt;/, it'll complete with e&gt;)


=== dix-mode ===
=== dix-mode ===
[[Image:dix.el.png|thumb|300px|right|Screenshot of an older version of dix.el in Aquamacs (fullscreen). Upper left window has output from dix-view-pardef, lower left shows rng schema completion. There is a red underline since a <code>p</code> can't be an empty element, as noted by the message in the minibuffer]]
[[Image:dix.el.png|thumb|300px|right|Screenshot of an older version of dix.el in Aquamacs (fullscreen). Upper left window has output from dix-view-pardef, lower left shows rng schema completion. There is a red underline since a <code>p</code> can't be an empty element, as noted by the message in the minibuffer]]


[https://github.com/unhammer/dix dix.el] is a minor mode under nxml-mode which gives some handy Apertium-related functions for XML editing. It is installed and turned on for the relevant file extensions by [[#Quickstart|init-apertium.el]].
In svn there is a minor mode for editing .dix files, [https://apertium.svn.sourceforge.net/svnroot/apertium/trunk/apertium-tools/dix.el dix.el] (or use <code>svn co https://apertium.svn.sourceforge.net/svnroot/apertium/trunk/apertium-tools</code>). It needs nxml-mode (see above, installed by default in emacs version 23 or above). There are some [http://www.youtube.com/playlist?list=PL99D23BDD6C7756E9 short screencasts here].


There are some [http://www.youtube.com/playlist?list=PL99D23BDD6C7756E9 short screencasts here] showing off some usage.
Put the following in your <code>~/.emacs</code> file to use it:
<pre>
(add-to-list 'load-path "/path/to/dix.el-folder") ; ie. path to the _folder_ containing dix.el
(autoload 'dix-mode "dix"
"dix-mode is a minor mode for editing Apertium XML dictionary files." t)
(add-hook 'nxml-mode-hook
(lambda () (and buffer-file-name
(string-match "\\.dix$" buffer-file-name)
(dix-mode 1))))
</pre>


I use [[Format dictionaries|Apertium-dixtools]]-formatted dix, not all functions have been tested in the regular format, but I've tried to make the functions use XML-movements so mostly they should work no matter how you format your files.
I use [[Format dictionaries|Apertium-dixtools]]-formatted dix with one line per &lt;e&gt;, not all functions have been tested in more verbose formats, but I've tried to make the functions use XML-movements so mostly they should work no matter how you format your files.


When you open emacs (after adding the above lines to ~/.emacs) and load a .dix-file, you should see a menu named ''dix''. Most of the functions added by dix-mode are shown in this menu (which also shows their keyboard shortcuts). Hovering over a menu-item might give a little popup-help. The ''Help for dix-mode'' entry will show all the user functions defined by dix-mode. The keyboard shortcuts are in general a lot more useful than the menu bar, which is mostly there in case you forget which buttons to press... ''Remember: C is Control, S is Shift, M is alt'' (well, M stands for Meta, but that's typically alt).
When you open emacs (after adding the above lines to ~/.emacs) and load a .dix-file, you should see a menu named ''dix''. Most of the functions added by dix-mode are shown in this menu (which also shows their keyboard shortcuts). Hovering over a menu-item might give a little popup-help. The ''Help for dix-mode'' entry will show all the user functions defined by dix-mode. The keyboard shortcuts are in general a lot more useful than the menu bar, which is mostly there in case you forget which buttons to press... ''Remember: C is Control, S is Shift, M is alt'' (well, M stands for Meta, but that's typically alt).
Line 111: Line 76:


* Movement and editing:
* Movement and editing:
** The '''space bar''' inserts a &lt;b/&gt; in &lt;r&gt;, &lt;l&gt; or &lt;i&gt; elements; a <code>_</code> in par/pardef names; otherwise a plain space.
** The '''space bar''' inserts a &lt;b/&gt; in &lt;r&gt;, &lt;l&gt; or &lt;i&gt; elements; a <code>_</code> in par/pardef names; otherwise a plain space. This [https://asciinema.org/a/26142 works with the . (repeat) command] as well, if you use the vim keybindings.
** '''M-n''' and '''M-p''' move to the next and previous "important bits" of &lt;e&gt;-elements (just try it!).
** '''M-n''' and '''M-p''' move to the next and previous "important bits" of &lt;e&gt;-elements (just try it!).


Line 152: Line 117:
'''M-n''' and '''M-p''' (go to next/previous useful position) should also Do What You Mean in transfer files.
'''M-n''' and '''M-p''' (go to next/previous useful position) should also Do What You Mean in transfer files.


=== Validation (Relax NG-schemas) ===
====Validation quickstart====


<br style="clear:both" />
Copy this script to a file like "makeschema.sh", making sure to set APERTIUMSRC to the folder containing the apertium source, and LTTOOLBOXSRC to the folder containing the lttoolbox source:
<pre>
#!/bin/bash


=== Validation (Relax NG-schemas) ===
## Set these to the correct paths:
APERTIUMSRC="$HOME/apertium-svn/trunk/apertium"
LTTOOLBOXSRC="$HOME/apertium-svn/trunk/lttoolbox"
SCHEMAFILE=~/.emacs.d/schemas.xml
# Change SCHEMAFILE if you want to put your schema locating file somewhere else.
# Note: this path can't have quotes around it for some reason


nxml-mode uses Compact Relax NG schemas (<code>.rnc</code> files) for validation (without these, XML is only checked for well-formedness by nxml-mode).
## No changes needed below


dix.el should find the .rnc's installed by lttoolbox/apertium if you've installed with packages (or even with "sudo make install" to /usr/local). If not, you'll have to copy the schemas.xml included with https://github.com/unhammer/dix into some folder, editing the paths to .rnc's in there, and put <code>(add-to-list 'rng-schema-locating-files "/path/to/your/schemas.xml")</code> in your ~/.emacs.d/init.el.
tmp=$(mktemp -dt schema.XXXXXXXXXXX)
trap 'rm -rf "${tmp}"' EXIT
trangjar=${tmp}/trang-20091111/trang.jar


You can toggle validation using the XML menu at the top of the screen, or the keyboard shortcut <code>C-c C-v</code>.
(
cd "$tmp"
echo "Downloading schema converter ..."
wget -q https://jing-trang.googlecode.com/files/trang-20091111.zip
unzip -q trang-20091111.zip
)


It can be a bit slow with big files; a
echo "Creating ${SCHEMAFILE}"
<pre>(add-hook 'nxml-mode-hook (lambda () (rng-validate-mode 0)) 'append)</pre>
cat > ${SCHEMAFILE} <<EOF
will turn it off by default (or just do <code>C-c C-v</code> to turn it off once).
<?xml version="1.0"?>
<locatingRules xmlns="http://thaiopensource.com/ns/locating-rules/1.0">
<typeId id="dix" uri="${LTTOOLBOXSRC}/lttoolbox/dix.rnc"/>
<typeId id="transfer" uri="${APERTIUMSRC}/apertium/transfer.rnc"/>
<typeId id="interchunk" uri="${APERTIUMSRC}/apertium/interchunk.rnc"/>
<typeId id="postchunk" uri="${APERTIUMSRC}/apertium/postchunk.rnc"/>
<typeId id="format" uri="${APERTIUMSRC}/apertium/format.rnc"/>
<typeId id="tagger" uri="${APERTIUMSRC}/apertium/tagger.rnc"/>
<typeId id="modes" uri="${APERTIUMSRC}/apertium/modes.rnc"/>


Validation can also provide "intelligent" tab completion of elements and attributes (see the function <code>nxml-complete</code>).
<documentElement localName="dictionary" typeId="dix"/>
<documentElement localName="transfer" typeId="transfer"/>
<documentElement localName="interchunk" typeId="interchunk"/>
<documentElement localName="postchunk" typeId="postchunk"/>
<documentElement localName="format" typeId="format"/>
<documentElement localName="tagger" typeId="tagger"/>
<documentElement localName="modes" typeId="modes"/>


=== Linting with flycheck ===
<uri pattern="*.dix" typeId="dix"/>
The package https://github.com/unhammer/flycheck-apertium/ (installed by [[#Quickstart|init-apertium.el]]) gives on-the-fly linting of dix files and transfer files.
<uri pattern="*.t1x" typeId="transfer"/>
<uri pattern="*.t2x" typeId="interchunk"/>
<uri pattern="*.t3x" typeId="interchunk"/>
<!-- Some pairs have t3x as postchunk, others t4x or even t5x... but
if one of the documentElement rules match, these rules are
ignored since they're below them. -->
</locatingRules>
EOF


For dix files, it assumes /usr/share/lttoolbox/dix.xsd exists (ie. you've installed lttoolbox from packages.
convert () {
echo "Creating rnc files in $(pwd)"
for inf in *.dtd; do
out=${inf%%.dtd}.rnc
java -jar "${trangjar}" "${inf}" "${out}"
done
}


For transfer files, it assumes you've got https://github.com/ggm/vm-for-transfer-cpp compiled and installed to your $PATH; this gives some extra info on transfer errors. If you've got the binary somewhere outside your $PATH, set it like this:
for dir in "${APERTIUMSRC}/apertium" "${LTTOOLBOXSRC}/lttoolbox"; do
<pre>
(
(setq flycheck-apertium-transfervm-executable "/home/me/src/vm-for-transfer-cpp/apertium-compile-transfer")
cd "$dir" && convert
)
done


cat <<EOF

Done! Now inform nxml-mode about ${SCHEMAFILE} by appending this to
~/.emacs.d/init.el:

(add-hook 'nxml-mode-hook
(lambda ()
(add-to-list 'rng-schema-locating-files "${SCHEMAFILE}")))

EOF
</pre>
</pre>
Note that the line numbers given by transfervm are at the end of the matching rule, not always at the exact line where the error occurred. But it's better than segfaults.


If any of the above files don't exist, the checker will just silently not run.
Run it like
bash makeschema.sh

and add the hook to your ~/.emacs.d/init.el as instructed by the script.

====More about nxml validation====
nxml-mode uses compact Relax NG schemas (<code>.rnc</code> files) for validation (without these, XML is only checked for well-formedness by nxml-mode).

You can make compact Relax NG schemas using [http://www.thaiopensource.com/relaxng/trang.html trang], see the above script.

Note: if you want to auto-complete using the schema (keyboard shortcut: C-RET in emacs 23; changed to M-TAB or C-M-i in emacs 24 and up), you should have <code>(add-to-list 'nxml-completion-hook 'rng-complete)</code> somewhere in your <code>~/.emacs</code>.

You can toggle validation using the XML menu at the top of the screen, or the keyboard shortcut <code>C-c C-v</code>.

See http://www.dpawson.co.uk/relaxng/nxml/schemaloc.html#d574e168 for how to write a schema.xml file to automatically find the right schema, or just use the quickstart script above.


=== Yasnippet ===
=== Yasnippet ===
Line 257: Line 151:
This section shows how to use the snippets made for dix-mode. There's a short screencast of it at https://asciinema.org/a/11192
This section shows how to use the snippets made for dix-mode. There's a short screencast of it at https://asciinema.org/a/11192


To use, first install yasnippet by doing <code>M-x package-refresh-contents</code> and <code>M-x package-install RET yasnippet RET</code> (assuming you've added [http://melpa.milkbox.net/#/getting-started melpa] to your package-archives).
To use, install yasnippet by doing <code>M-x package-refresh-contents</code> and <code>M-x package-install RET yasnippet RET</code> (assuming you've added [http://melpa.milkbox.net/#/getting-started melpa] to your package-archives; this happens automatically when you add [[#Quickstart|init-apertium.el]]).

Then get the dix-mode snippets, this will put them (and a bunch of other snippets) into the default snippets path:
<pre>
git clone -b dix-mode https://github.com/unhammer/yasnippet-snippets.git ~/.emacs.d/snippets
</pre>


Then put this into ~/.emacs.d/init.el to make the snippets available in dix-mode:
Then put this into ~/.emacs.d/init.el to make the snippets available in dix-mode:
Line 282: Line 171:


== HFST ==
== HFST ==
[[Image:Hfst-mode.png|thumb|300px|right|Screenshot of syntax highlighting in hfst-mode.el]]

* [https://github.com/unhammer/hfst-mode HFST-mode] is for editing the lexc and twol files used with [[HFST]]
* [https://github.com/unhammer/hfst-mode HFST-mode] is for editing the lexc and twol files used with [[HFST]]
* [http://www.cis.uni-muenchen.de/~wastl/emacs/sfst.el SFST-mode] is for editing [[SFST]] files
* [http://www.cis.uni-muenchen.de/~wastl/emacs/sfst.el SFST-mode] is for editing [[SFST]] files

HFST-mode provides go-to-lexicon on M-. (and back with M-,), and will syntax highlight occurrences of Multichar_Symbols in lexicons, so you can easily tell if you've mistyped or forgotten to define a symbol.


<br style="clear:both" />


== CG ==
== CG ==
[[Image:cg.el.cg-output.screenshot.png|thumb|300px|right|Screenshot after running the grammar ('''C-c C-c''') on an rlx file in cg.el]]
[[Image:cg.el.cg-output.screenshot.png|thumb|300px|right|Screenshot after running the grammar ('''C-c C-c''') on an rlx file in cg.el]]


There is a [http://anonymous:anonymous@beta.visl.sdu.dk/svn/visl/tools/vislcg3/trunk/emacs/cg.el CG-mode for emacs] in the vislcg3 repository (see [[Constraint Grammar]]). It's installed by default to $prefix/share/emacs/site-lisp/cg3-mode.el. Since /usr and /usr/local are in the default emacs load-path, you should be able to get going by simply putting this in your ~/.emacs.d/init.el:
There is a [https://github.com/GrammarSoft/cg3/blob/main/emacs/cg.el CG-mode for emacs] in the vislcg3 repository (see [[Constraint Grammar]]). It's installed by [[#Quickstart|init-apertium.el]].


<pre>
(autoload 'cg-mode
"cg.el" ; specify the full path to cg.el here if you installed to a non-standard prefix
"cg-mode is a major mode for editing Constraint Grammar files." t)
(add-to-list 'auto-mode-alist '("\\.cg3\\'" . cg-mode))
(add-to-list 'auto-mode-alist '("\\.rlx\\'" . cg-mode))
</pre>


You can use '''C-;''' (alternative keybinding '''M-#''') to quickly comment/uncomment a rule ([https://asciinema.org/a/25236 quick demo]). '''C-M-a/e''' move back and forth full rules (alternatively, '''M-a/e''' moves back/forth by "sentences" which includes commented rules).
This will load cg.el and run cg-mode when you open files with names ending in .cg3 or .rlx.




Line 308: Line 197:


Now you can do '''C-c C-i''' to type in some test text, then '''C-c C-c''' (either in that buffer or in the CG buffer) to test the CG on the text. You can do '''C-c c''' to toggle if you want to test the text for every change you do (some might find that annoying). You can click REMOVE, SELECT, MAP, ADD etc. in the output to go to the corresponding line, or use '''C-c C-n''' / '''C-c C-p''' to go back and forth between occurrences (also works for warnings and compile errors).
Now you can do '''C-c C-i''' to type in some test text, then '''C-c C-c''' (either in that buffer or in the CG buffer) to test the CG on the text. You can do '''C-c c''' to toggle if you want to test the text for every change you do (some might find that annoying). You can click REMOVE, SELECT, MAP, ADD etc. in the output to go to the corresponding line, or use '''C-c C-n''' / '''C-c C-p''' to go back and forth between occurrences (also works for warnings and compile errors).

You can use '''C-;''' (alternative keybinding '''M-#''') to quickly comment/uncomment a rule ([https://asciinema.org/a/25236 quick demo]). '''C-M-a/e''' move back and forth full rules (alternatively, '''M-a/e''' moves back/forth by "sentences" which includes commented rules).


[[Image:Cg.el.hiding.screenshot.png|thumb|300px|right|Screenshot after running the grammar ('''C-c C-c''') and hitting '''u''' to hide everything but analyses containing ''det dem'']]
[[Image:Cg.el.hiding.screenshot.png|thumb|300px|right|Screenshot after running the grammar ('''C-c C-c''') and hitting '''u''' to hide everything but analyses containing ''det dem'']]


If you have a lot of input sentences you want to test at once, you can hide all analyses, except ones matching some regex. Select the output buffer, then hit '''u''' and type in a regex for analyses you want to see (e.g. <code>vblex</code>, or <code>\b\(sg\|pl\)\b</code> to match pl or sg but not the string "place"). Now you should see only the wordforms in the output buffer, except for analyses containing your exceptions. Type '''h''' to toggle between a full view and hiding (click a word when hiding and press '''h''' to ensure you're scrolled into the analysis of that word). See also the variable <code>cg-sent-tag</code> which is used to keep linebreaks after certain tags; if you use a non-Apertium sentence tag you may want to put in your ~/.emacs something like <code>(setq cg-sent-tag "\\bpunct\\b")</code> (if your sentence tag was <code>punct</code>).
If you have a lot of input sentences you want to test at once, you can hide all analyses, except ones matching some regex. Select the output buffer, then hit '''u''' and type in a regex for analyses you want to see (e.g. <code>vblex</code>, or <code>\b\(sg\|pl\)\b</code> to match pl or sg but not the string "place"). Now you should see only the wordforms in the output buffer, except for analyses containing your exceptions. Type '''h''' to toggle between a full view and hiding (click a word when hiding and press '''h''' to ensure you're scrolled into the analysis of that word). See also the variable <code>cg-sent-tag</code> which is used to keep linebreaks after certain tags; if you use a non-Apertium sentence tag you may want to put in your ~/.emacs something like <code>(setq cg-sent-tag "\\bpunct\\b")</code> (if your sentence tag was <code>punct</code>).

[[Image:Cg-mode-hide-unhide.gif|Demo of hide/unhide (h/u) in cg-mode output, rule trace and editing]]


There is also error underlining (using the builtin flymake mode); the following is a plain emacs setup using only [unhammer.org/cg-init.el this init file], and the toolbar enabled for buttons:

[[Image:Cg-flymake.gif|Demo error underlining and input example testing]]


<br style="clear:both" />


== IRC ==
== IRC ==
Line 321: Line 218:
* [http://www.emacswiki.org/emacs/ZenCoding ZenCoding] lets you type <code>section#main>e*2</code> and it turns it into the full <pre><section id="main"><e></e><e></e></section></pre>, etc.
* [http://www.emacswiki.org/emacs/ZenCoding ZenCoding] lets you type <code>section#main>e*2</code> and it turns it into the full <pre><section id="main"><e></e><e></e></section></pre>, etc.
* [http://www.emacswiki.org/emacs/Yasnippet YASnippet] is a template system ([http://www.youtube.com/watch?v=76Ygeg9miao automatically expand abbreviations])
* [http://www.emacswiki.org/emacs/Yasnippet YASnippet] is a template system ([http://www.youtube.com/watch?v=76Ygeg9miao automatically expand abbreviations])
* [[Text Editors Compatible With Different Scripts]] about RTL, bidi support


[[Category: Writing dictionaries]]
[[Category: Writing dictionaries]]

Latest revision as of 12:46, 23 March 2022

Info on using Emacs for Apertium-related tasks.

Quickstart[edit]

There is an init file in git that will give your Emacs some useful Apertium-related packages and settings, including:

  • dix-mode, for XML dictionary and transfer editing
  • cg-mode, for Constraint Grammar rule editing and testing
  • hfst-mode, for lexc/twol syntax highlighting
  • tab-completion

To get that set up, simply

mkdir -p ~/.emacs.d/
curl https://raw.githubusercontent.com/unhammer/dix/master/init-apertium.el > ~/.emacs.d/init-apertium.el
echo '(load "~/.emacs.d/init-apertium.el")' >> ~/.emacs.d/init.el
emacs

The last line starts up Emacs, which will download the new packages since it's the first startup. (The next startups will be much faster.)

If you ever want to update your installed Emacs packages, you do M-x list-packages, then U x.


The rest of this page gives some documentation of the various modes.

Mac OS X[edit]

If you're on Mac, the built-in emacs is ancient. Don't use that. Instead, get https://emacsformacosx.com/

You can make an alias to start this emacs from the command line with e.g.

alias em="open -a /Applications/Emacs.app"

(If you prefer having non-GUI emacs, change that to alias em="open -a /Applications/Emacs.app -nw".)

Validation slow?[edit]

The above init-apertium.el turns on on-the-fly XML validation, which can be slow on old computers. If editing large .dix files seems too slow, try turning off one or both of the validators by putting

(add-hook 'nxml-mode-hook (lambda () (rng-validate-mode 0)) 'append)

in your ~/.emacs.d/init.el

XML (dix, transfer, …) editing[edit]

nxml-mode[edit]

Emacs has a nice xml editing mode (included as of version 23) called nXML, with syntax highlighting, movement commands to navigate through the XML (out of, into, across elements, etc.). It also has validation, and can auto-complete using the XML schema if a schema file is available.

init-apertium.el turns on nxml-mode for the common Apertium XML file extensions.

keybindings[edit]

init-apertium.el also turns on the variable nxml-sexp-element-flag, which lets you use the following handy keys:

  • C-M-f to move forward one element (e.g. from <e> to </e>)
  • C-M-b to move backward one element (e.g. from </e> to <e>)
  • C-M-d to move into one element (e.g. from <e> to <p>)
  • M-S-d (meta-shift-d) to move into one element backwards (e.g. from after </e> to after </p>)
  • C-M-u to move out of one element (e.g. from <p> to <e>)
  • C-M-k to kill (cut) one element

and nxml-slash-auto-complete-flag which lets you type

  • </ to write the end tag of whatever element you're in (e.g. after typing <e><p>…</p></, it'll complete with e>)

dix-mode[edit]

Screenshot of an older version of dix.el in Aquamacs (fullscreen). Upper left window has output from dix-view-pardef, lower left shows rng schema completion. There is a red underline since a p can't be an empty element, as noted by the message in the minibuffer

dix.el is a minor mode under nxml-mode which gives some handy Apertium-related functions for XML editing. It is installed and turned on for the relevant file extensions by init-apertium.el.

There are some short screencasts here showing off some usage.

I use Apertium-dixtools-formatted dix with one line per <e>, not all functions have been tested in more verbose formats, but I've tried to make the functions use XML-movements so mostly they should work no matter how you format your files.

When you open emacs (after adding the above lines to ~/.emacs) and load a .dix-file, you should see a menu named dix. Most of the functions added by dix-mode are shown in this menu (which also shows their keyboard shortcuts). Hovering over a menu-item might give a little popup-help. The Help for dix-mode entry will show all the user functions defined by dix-mode. The keyboard shortcuts are in general a lot more useful than the menu bar, which is mostly there in case you forget which buttons to press... Remember: C is Control, S is Shift, M is alt (well, M stands for Meta, but that's typically alt).


Some useful functions in dix-mode:

  • Movement and editing:
    • The space bar inserts a <b/> in <r>, <l> or <i> elements; a _ in par/pardef names; otherwise a plain space. This works with the . (repeat) command as well, if you use the vim keybindings.
    • M-n and M-p move to the next and previous "important bits" of <e>-elements (just try it!).
  • Copying elements and adding restrictions:
    • C-c C just creates a copy of the current <e> element, putting it below the current one
    • C-c L and C-c R also make a copy of the current <e> element, but with an LR or RL restriction
    • C-TAB cycles between the restriction possibilities LR, RL or none for the current <e> element
    • C-S-TAB, used with elements that have the slr/srl attribute, will swap the sense translation of this <e> with the <e> above
  • Creating elements from plain text:
    • C-c g in a monodix guesses the pardef for a word based on the suffix. Write a word in the bottom of a dix files, place point somewhere in the middle of the word, and hit C-c g, it'll try to find words earlier in the file that have the same ending (characters after point)
    • C-c x in a monodix or bidix turns a word-list into <e> entries using the above <e> entry as a template. Words should be written one per line. You can use it in a bidix by writing the left-side, then a colon (:) then the right-side. Assumes that the entry used as a template is written all on one line.
  • Pardef viewing and manipulation:
    • C-c G will go to the pardef of the nearest <par>
      • the place you left is saved in the standard emacs fashion, so you can go back by pressing C-u C-SPACE
    • C-c V will show the pardef of the nearest <par> in another window
    • C-c S will sort a pardef by its right-hand-side, <r>.
      • You can also do M-x dix-sort-e-by-l to sort the selected <e;> elements by the contents of their <l> element
    • C-c D (in a pardef or an <e>) will print a list of all pardefs which have the same suffixes as this one (where a 'suffix' is the contents of an <l>-element), useful for finding duplicates. Note: it ignores the tags
    • Inside a pardef, C-c A shows all usages of that pardef within the dictionaries represented by the variable `dix-dixfiles'


Note: capital letters means you have to press shift. If you fancy other keyboard shortcuts, copy the relevant define-key entries from the bottom of dix.el, put them in your ~/.emacs, e.g. to add F12 as an alternative to C-c V:

(add-hook 'dix-mode-hook (lambda nil (define-key dix-mode-map (kbd "<f12>") 'dix-view-pardef)))

(the whole add-hook thing is needed since dix-mode is not loaded until the first .dix-file is loaded)


Also, if you like having all <i> elements aligned at eg. column 25, select a region and do M-x align to achieve that (this also aligns <p> to 10 and <r> to 44, for bidix). These numbers are customizable with M-x customize-group RET dix. (Ie. there's no extra indentation function, but then, nxml already has that.)

dix-mode for transfer rules[edit]

Useful in transfer mode too!

There are some transfer-specific functions in dix-mode that make it worth turning on in transfer mode files too, e.g. C-c n, which lets you enter a rule number to go to (useful when tracing with apertium-transfer -t). The .emacs in the Quickstart section will turn on nxml-mode and dix-mode in transfer files (ie. all files with the suffix .t1x, .t2x, .t3x, etc.).

M-n and M-p (go to next/previous useful position) should also Do What You Mean in transfer files.



Validation (Relax NG-schemas)[edit]

nxml-mode uses Compact Relax NG schemas (.rnc files) for validation (without these, XML is only checked for well-formedness by nxml-mode).

dix.el should find the .rnc's installed by lttoolbox/apertium if you've installed with packages (or even with "sudo make install" to /usr/local). If not, you'll have to copy the schemas.xml included with https://github.com/unhammer/dix into some folder, editing the paths to .rnc's in there, and put (add-to-list 'rng-schema-locating-files "/path/to/your/schemas.xml") in your ~/.emacs.d/init.el.

You can toggle validation using the XML menu at the top of the screen, or the keyboard shortcut C-c C-v.

It can be a bit slow with big files; a

(add-hook 'nxml-mode-hook (lambda () (rng-validate-mode 0)) 'append)

will turn it off by default (or just do C-c C-v to turn it off once).

Validation can also provide "intelligent" tab completion of elements and attributes (see the function nxml-complete).

Linting with flycheck[edit]

The package https://github.com/unhammer/flycheck-apertium/ (installed by init-apertium.el) gives on-the-fly linting of dix files and transfer files.

For dix files, it assumes /usr/share/lttoolbox/dix.xsd exists (ie. you've installed lttoolbox from packages.

For transfer files, it assumes you've got https://github.com/ggm/vm-for-transfer-cpp compiled and installed to your $PATH; this gives some extra info on transfer errors. If you've got the binary somewhere outside your $PATH, set it like this:

  (setq flycheck-apertium-transfervm-executable  "/home/me/src/vm-for-transfer-cpp/apertium-compile-transfer")

Note that the line numbers given by transfervm are at the end of the matching rule, not always at the exact line where the error occurred. But it's better than segfaults.

If any of the above files don't exist, the checker will just silently not run.

Yasnippet[edit]

Yasnippet is a snippet-expansion package for Emacs. It lets you write boilerplate faster. This section shows how to use the snippets made for dix-mode. There's a short screencast of it at https://asciinema.org/a/11192

To use, install yasnippet by doing M-x package-refresh-contents and M-x package-install RET yasnippet RET (assuming you've added melpa to your package-archives; this happens automatically when you add init-apertium.el).

Then put this into ~/.emacs.d/init.el to make the snippets available in dix-mode:

(eval-after-load 'yasnippet
  '(progn
     (setq yas-verbosity 1)
     (yas-reload-all)
     (remhash 'nxml-mode yas--tables) ; until https://github.com/AndreaCrotti/yasnippet-snippets/issues/41 is solved
     (add-to-list 'yas-key-syntaxes 'dix-yas-skip-backwards-to-key)
     ; The default is to use a point-and-click menu when there are several choices, I prefer ido:
     (setq yas-prompt-functions '(yas-ido-prompt yas-completing-prompt yas-dropdown-prompt yas-no-prompt))
  ))
(add-hook 'dix-mode-hook 'yas-minor-mode)

C++[edit]

See Emacs C style for Apertium hacking.

HFST[edit]

Screenshot of syntax highlighting in hfst-mode.el

HFST-mode provides go-to-lexicon on M-. (and back with M-,), and will syntax highlight occurrences of Multichar_Symbols in lexicons, so you can easily tell if you've mistyped or forgotten to define a symbol.



CG[edit]

Screenshot after running the grammar (C-c C-c) on an rlx file in cg.el

There is a CG-mode for emacs in the vislcg3 repository (see Constraint Grammar). It's installed by init-apertium.el.


You can use C-; (alternative keybinding M-#) to quickly comment/uncomment a rule (quick demo). C-M-a/e move back and forth full rules (alternatively, M-a/e moves back/forth by "sentences" which includes commented rules).


If you want to test the CG while you're working on it from within Emacs, you can add a line like

# -*- cg-pre-pipe: "apertium -d . nb-nn-morph|cg-conv -a 2>/dev/null" -*-

to the top of your CG file (replace nb-nn-morph for whatever mode that runs everything up until cg-proc in your regular mode, or just use something like lt-proc some.automorf.bin|cg-conv -a 2>/dev/null). Then close and re-open the file, and hit ! when you're asked whether you approve of the command (you only have to do this once).

Now you can do C-c C-i to type in some test text, then C-c C-c (either in that buffer or in the CG buffer) to test the CG on the text. You can do C-c c to toggle if you want to test the text for every change you do (some might find that annoying). You can click REMOVE, SELECT, MAP, ADD etc. in the output to go to the corresponding line, or use C-c C-n / C-c C-p to go back and forth between occurrences (also works for warnings and compile errors).

Screenshot after running the grammar (C-c C-c) and hitting u to hide everything but analyses containing det dem

If you have a lot of input sentences you want to test at once, you can hide all analyses, except ones matching some regex. Select the output buffer, then hit u and type in a regex for analyses you want to see (e.g. vblex, or \b\(sg\|pl\)\b to match pl or sg but not the string "place"). Now you should see only the wordforms in the output buffer, except for analyses containing your exceptions. Type h to toggle between a full view and hiding (click a word when hiding and press h to ensure you're scrolled into the analysis of that word). See also the variable cg-sent-tag which is used to keep linebreaks after certain tags; if you use a non-Apertium sentence tag you may want to put in your ~/.emacs something like (setq cg-sent-tag "\\bpunct\\b") (if your sentence tag was punct).

Demo of hide/unhide (h/u) in cg-mode output, rule trace and editing


There is also error underlining (using the builtin flymake mode); the following is a plain emacs setup using only [unhammer.org/cg-init.el this init file], and the toolbar enabled for buttons:

Demo error underlining and input example testing



IRC[edit]

Do M-x erc to start the IRC client. See http://www.emacswiki.org/emacs/ErcBasics and http://emacs-fu.blogspot.com/2009/06/erc-emacs-irc-client.html for more info.

See also[edit]