summaryrefslogtreecommitdiffstats
path: root/JLanguageTool/website/www/usage/index.php
blob: 477daff9839ddf09c4dd78c5e40bd77bc1344de8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
<?php
$page = "usage";
$title = "LanguageTool";
$title2 = "Usage";
$lastmod = "2008-02-17 19:20:00 CET";
include("../../include/header.php");
include('../../include/geshi/geshi.php');
?>
		
<p><strong>Installation and Usage outside OpenOffice.org</strong></p>

<p>See <?=show_link("Overview", "/", 0)?> for a description of how to use LanguageTool
with OpenOffice.org.</p>

<ul class="largelist">

	<li><strong>As a stand-alone application</strong>:
	Rename the archive so it ends with ".zip" and unzip it. If you're
	using Java 5.0, also unzip the <tt>standalone-libs.zip</tt> that will be created.
	Then start <tt>LanguageToolGUI.jar</tt> by double clicking on it. If your computer isn't
	configured to start jar archives, start it from the command line using<br />
	<tt>java -jar LanguageToolGUI.jar</tt><br />
	You can use the <tt>--tray</tt> option to start LanguageTool inside the system tray.
	</li>

	<li><strong>As a stand-alone application on the command line</strong>:
	see above, but start LanguageTool.jar using<br />
	<tt>java -jar LanguageTool.jar &lt;filename></tt><br />
	LanguageTool only supports plain text files.</li>

	<li><strong>Embedding LanguageTool in Java applications:</strong> See
	<?=show_link("the API documentation", "/development/api/", 0) ?>. You just need to create a 
	JLanguageTool object and use that
	to check your text. For example:
	<br /><br />
	
	<?php hljava('JLanguageTool langTool = new JLanguageTool(Language.ENGLISH);
langTool.activateDefaultPatternRules();
List<RuleMatch> matches = langTool.check("A sentence " + 
    "with a error in the Hitchhiker\'s Guide tot he Galaxy");
for (RuleMatch match : matches) {
  System.out.println("Potential error at line " +
      match.getEndLine() + ", column " +
      match.getColumn() + ": " + match.getMessage());
  System.out.println("Suggested correction: " +
      match.getSuggestedReplacements());
}'); ?>
	<br />		
	</li>

	<li><strong>Using LanguageTool from other applications:</strong> Start the stand-alone
	application and configure it to listen on a port that is not used yet (the default
	port, 8081, should often be okay). This way LanguageTool will run in server mode
	until you stop it. <br />
	The client that wants to use LanguageTool can now just send its text to this URL:<br />
	<tt>http://localhost:8081/?language=xx&amp;text=my+text</tt><br />
	The <tt>language</tt> parameter must specify the two-character language code
	(the language of the text to be checked). The <tt>text</tt> parameter is the
	text itself (you may need to encode it for URLs). You can use both POST and
	GET to send your requests to the LanguageTool server.<br />
	For the input "this is a test" the LanguageTool server will reply with this
	XML response:<br/><br/>
	
<?php hl('<?xml version="1.0" encoding="UTF-8"?>
<matches>
<error fromy="0" fromx="0" toy="0" tox="5" 
  ruleId="UPPERCASE_SENTENCE_START" 
  msg="This sentence does not start with an uppercase letter" 
  replacements="This" context="this is a test." 
  contextoffset="0"
  errorlength="4"/>
</matches>'); ?>

	<p>The server can also be started on the command line using this command:<br />
	<tt>java -cp jaminid.jar:LanguageTool.jar de.danielnaber.languagetool.server.HTTPServer</tt>

	</li>

</ul>

<?php
include("../../include/footer.php");
?>