Apertium-html-tools - Revision history

Firespeaker: /* Docs */

2025-09-18T18:32:19Z

Docs

TommiPirinen: maybe outdated? I uopdated this from readme while testing current version

2024-08-16T19:21:00Z

maybe outdated? I uopdated this from readme while testing current version

Firespeaker: /* Credits */

2019-10-24T05:25:44Z

Credits

Sushain at 04:58, 8 March 2018

2018-03-08T04:58:52Z

Sushain: /* Getting Started */

2017-10-14T22:41:36Z

Getting Started

Sushain at 22:40, 14 October 2017

2017-10-14T22:40:21Z

Sushain: /* Progress */

2017-03-12T03:42:20Z

Progress

Sushain: /* Quick and easy */

2017-01-08T23:17:34Z

Quick and easy

Sushain: /* Localisation */

2017-01-08T23:16:46Z

Localisation

Sushain: /* Development */

2017-01-08T23:13:35Z

Development

@@ Line 215: / Line 215: @@
 == Docs ==
 * [[/Localisation]]
+* [[/Paradigm dictionary]]
 == Credits ==

@@ Line 6: / Line 6: @@
 === Getting Started ===
-Using Html-tools is as easy as cloning from git, changing the configuration and running make.
+Using Html-tools is as easy as cloning from git, changing the configuration and running yarn.
  $ git clone https://github.com/apertium/apertium-html-tools.git
  $ cd apertium-html-tools/
- $ make # To create a blank config file
+ $ vim ./config.ts
+ $ yarnpkg install
- $ vim ./config.conf # Edit the configuration, see next section for more details
+ $ yarnpkg build
- $ make
-The last step is pointing your web server of choice, e.g. Apache, to serve the directory <code>/build</code> or running <code>python3 -m http.server</code> in <code>/build</code>.
+The last step is pointing your web server of choice, e.g. Apache, to serve the directory <code>dist</code> or running <code>python3 -m http.server</code> in <code>/build</code>.
 === Configuration ===

@@ Line 243: / Line 243: @@
 * [[User:Tarjimon|bmansurov]] (Uzbek)
 * [https://github.com/apertium/apertium-html-tools/commit/05683a2a8d5133cb8a9f0fe8fad86be3885bda02 Çağrı] (Turkish)
+== Please cite ==
+* https://www.aclweb.org/anthology/W18-2207/
 [[Category:User interfaces]]

@@ Line 1: / Line 1: @@
 {{TOCD}}
-'''Apertium Html-tools''' is a web application providing a fully localised interface for text/document/website translation, analysis, and generation powered by Apertium. Designed to use only static resources for quick and easy deployment with any web server, it is relatively lightweight and user-friendly. It is currently located on Github at [https://github.com/goavki/apertium-html-tools github.com/goavki/apertium-html-tools]. Html-tools relies on an Apertium HTTP API such as [[Apertium-apy]] or [[ScaleMT]] (to a lesser extent).
+'''Apertium Html-tools''' is a web application providing a fully localised interface for text/document/website translation, analysis, and generation powered by Apertium. Designed to use only static resources for quick and easy deployment with any web server, it is relatively lightweight and user-friendly. It is currently located on Github at [https://github.com/apertium/apertium-html-tools github.com/apertium/apertium-html-tools]. Html-tools relies on an Apertium HTTP API such as [[Apertium-apy]] or [[ScaleMT]] (to a lesser extent).
 == Usage ==
@@ Line 8: / Line 8: @@
 Using Html-tools is as easy as cloning from git, changing the configuration and running make.
- $ git clone https://github.com/goavki/apertium-html-tools.git
+ $ git clone https://github.com/apertium/apertium-html-tools.git
  $ cd apertium-html-tools/
  $ make # To create a blank config file
@@ Line 17: / Line 17: @@
 === Configuration ===
-Since Html-tools is powered entirely by static resources, a configuration file generated at <code>apertium-html-tools/config.conf</code> (based on <code>[https://github.com/goavki/apertium-html-tools/blob/master/config.conf.example config.conf.example]</code>) is maintained to allow users to modify basic environment parameters such as API location and enabled interfaces. Following is a summary of the currently supported arguments with some examples:
+Since Html-tools is powered entirely by static resources, a configuration file generated at <code>apertium-html-tools/config.conf</code> (based on <code>[https://github.com/apertium/apertium-html-tools/blob/master/config.conf.example config.conf.example]</code>) is maintained to allow users to modify basic environment parameters such as API location and enabled interfaces. Following is a summary of the currently supported arguments with some examples:
 * '''APY_URL''': the URL of an API instance (ScaleMT for basic functionality, [[APY]] for full) that the web application calls
@@ Line 110: / Line 110: @@
 ==== Quick and easy ====
 If you don't know what git is, or you'd rather not deal with it, follow these steps.
-# Download the <tt>eng.json</tt> file from [https://github.com/goavki/apertium-html-tools/blob/master/assets/strings/ this directory].
+# Download the <tt>eng.json</tt> file from [https://github.com/apertium/apertium-html-tools/blob/master/assets/strings/ this directory].
 # Download the file for your language too. If one doesn't exist, make a copy of the <tt>eng.json</tt> file for your language.  You could also download the file for a language similar to your language or one that you're more comfortable with.
 # Base your translations off the <tt>eng.json</tt> file, as the English strings file is the only one guaranteed to be up-to-date.
@@ Line 116: / Line 116: @@
 ==== Creating a new translation ====
-# Clone the apertium-html-tools repo, which has all the localisation files in apertium-html-tools: <code>git clone git@github.com:goavki/apertium-html-tools.git</code>.
+# Clone the apertium-html-tools repo, which has all the localisation files in apertium-html-tools: <code>git clone git@github.com:apertium/apertium-html-tools.git</code>.
 # Look at a deployed version of the html-tools interface, preferably one with all/most modes enabled. See the section on deployed sites for where to go.
 #
@@ Line 127: / Line 127: @@
 # Run <code>./localisation-tools.py all fin</code>, replacing <code>fin</code> with your language's ISO 639-3 code and see whether <code>completion</code> is 100 (percent). If not, keep translating (what you're missing is shown in <code>missing</code>) and running this step's command.
 # If you didn't manage to run localisation-tools.py because of an exception, you might have made an error in the json-file. You can check your JSON with http://jsonlint.com/ or similar.
-#'''Optional:''' Add your name to the <code>"authors"</code> key and update the <code>"last-updated"</code> key. Add a line to [https://github.com/goavki/apertium-html-tools/blob/master/assets/strings/locales.json assets/strings/locales.json] with the language code mapped to the language's native name (endonym).
+#'''Optional:''' Add your name to the <code>"authors"</code> key and update the <code>"last-updated"</code> key. Add a line to [https://github.com/apertium/apertium-html-tools/blob/master/assets/strings/locales.json assets/strings/locales.json] with the language code mapped to the language's native name (endonym).
 # Commit your changes to git: <code>git commit ./ -m "Your message..."</code>
 # If you didn't edit <tt>locales.json</tt>, let us know in [[IRC]] so that we can edit it for you and update websites. Thanks!
 ==== Updating an existing translation ====
-# Clone the apertium-html-tools repo, which has all the localisation files in apertium-html-tools: <code>git clone git@github.com:goavki/apertium-html-tools.git</code>.
+# Clone the apertium-html-tools repo, which has all the localisation files in apertium-html-tools: <code>git clone git@github.com:apertium/apertium-html-tools.git</code>.
 # Look at a deployed version of the html-tools interface, preferably one with all/most modes enabled. See the section on deployed sites for where to go.
@@ Line 147: / Line 147: @@
 ==== Progress ====
-Updated 8 January 2017. Generated by [https://github.com/goavki/apertium-html-tools/blob/master/assets/strings/progresstable.sh progresstable.sh].
+Updated 8 January 2017. Generated by [https://github.com/apertium/apertium-html-tools/blob/master/assets/strings/progresstable.sh progresstable.sh].
 {| class="wikitable sortable"
@@ Line 242: / Line 242: @@
 * vmax = Max Vorobev (Russian)
 * [[User:Tarjimon|bmansurov]] (Uzbek)
-* [https://github.com/goavki/apertium-html-tools/commit/05683a2a8d5133cb8a9f0fe8fad86be3885bda02 Çağrı] (Turkish)
+* [https://github.com/apertium/apertium-html-tools/commit/05683a2a8d5133cb8a9f0fe8fad86be3885bda02 Çağrı] (Turkish)
 [[Category:User interfaces]]

@@ Line 10: / Line 10: @@
  $ git clone https://github.com/goavki/apertium-html-tools.git
  $ cd apertium-html-tools/
- $ make #To create a blank config file
+ $ make # To create a blank config file
- $ vim ./config.conf #Edit the configuration, see next section for more details
+ $ vim ./config.conf # Edit the configuration, see next section for more details
  $ make

@@ Line 104: / Line 104: @@
 === Localisation ===
-The Html-tools interface is '''fully''' localisable and has support for RTL languages. The 25 currently available languages are Aragonese (arg), Avar (ava), Catalan (cat), English (eng), Basque (eus), French (fra), German (deu), Hebrew (heb), Karakalpak (kaa), Kazakh (kaz), Kyrgyz (kir), Nynorsk Norwegian (nno), Bokmål Norwegian (nob), Occitan (oci), Portuguese (por), Romanian (ron), Saami (sme), Spanish (spa), Tatar (tat), Thai (tha), Uzbek (uzb), Uyghur (uig), and Chinese (zho).
+The Html-tools interface is '''fully''' localisable and has support for RTL languages. The 26 currently available languages are Aragonese (arg), Avar (ava), Catalan (cat), English (eng), Basque (eus), French (fra), German (deu), Hebrew (heb), Karakalpak (kaa), Kazakh (kaz), Kyrgyz (kir), Nynorsk Norwegian (nno), Bokmål Norwegian (nob), Occitan (oci), Portuguese (por), Romanian (ron), Saami (sme), Spanish (spa), Tatar (tat), Thai (tha), Turkish (tur), Uzbek (uzb), Uyghur (uig), and Chinese (zho).
 Contributing a new translation of the interface is encouraged and a very simple process.

@@ Line 63: / Line 63: @@
  while true; do inotifywait . -r -e MODIFY && make debug -j32; done;      # Linux
- while true; do fswatch -o -r . | make debug -j32; done;                             # OS X
+ while true; do fswatch -o -r . | make debug -j32; done;                  # OS X
 == Current Status ==