Skip to content

Commit

Permalink
Update userguide html
Browse files Browse the repository at this point in the history
  • Loading branch information
@nreimers
nreimers committed Dec 10, 2015
1 parent 306c5ad commit 87131eb
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions doc/user-guide.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -749,7 +749,7 @@ <h1>DARIAH-DKPro-Wrapper v0.4.1</h1>
</div>
</div>
<div class="sect1">
<h2 id="_system_requirements">System Requirements</h2>
<h2 id="_system_requirements">1. System Requirements</h2>
<div class="sectionbody">
<div class="paragraph"><p>To run the pipeline properly, a system equipped with and able to handle at least 4 GB RAM is recommended. The following operating systems have been tested:</p></div>
<div class="ulist"><div class="title">Systems:</div><ul>
Expand All @@ -774,7 +774,7 @@ <h2 id="_system_requirements">System Requirements</h2>
</div>
</div>
<div class="sect1">
<h2 id="_running_the_pipeline">Running the pipeline</h2>
<h2 id="_running_the_pipeline">2. Running the pipeline</h2>
<div class="sectionbody">
<div class="paragraph"><p>After downloading and unzipping the files, execute in your command line the following code:</p></div>
<div class="sidebarblock">
Expand All @@ -789,14 +789,14 @@ <h2 id="_running_the_pipeline">Running the pipeline</h2>
</div>
</div>
<div class="sect1">
<h2 id="_run_the_full_pipeline">Run the full pipeline</h2>
<h2 id="_run_the_full_pipeline">3. Run the full pipeline</h2>
<div class="sectionbody">
<div class="paragraph"><p>By default, the pipeline runs in a light mode, the memory and time intensive components for parsing and semantic role labeling are <strong>disabled</strong>.</p></div>
<div class="paragraph"><p>If you like to use them, feel free to enable them in the <tt>default.properties</tt> or create a new <tt>.properties</tt>-File and pass the path to this file via the <tt>config</tt>-parameter.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_programm_parameters">Programm Parameters</h2>
<h2 id="_programm_parameters">4. Programm Parameters</h2>
<div class="sectionbody">
<div class="paragraph"><p>Run <tt>java -jar ddw-0.4.1.jar -help</tt> to get an overview of the possible command line arguments:</p></div>
<div class="listingblock">
Expand All @@ -813,11 +813,11 @@ <h2 id="_programm_parameters">Programm Parameters</h2>
</div>
</div>
<div class="sect1">
<h2 id="_file_reader">File Reader</h2>
<h2 id="_file_reader">5. File Reader</h2>
<div class="sectionbody">
<div class="paragraph"><p>You can process either single files or also all files inside a directory. Patterns can be used to select specific files that should be processed.</p></div>
<div class="sect2">
<h3 id="_text_reader_amp_xml_reader">Text Reader &amp; XML Reader</h3>
<h3 id="_text_reader_amp_xml_reader">5.1. Text Reader &amp; XML Reader</h3>
<div class="paragraph"><p>The DARIAH-DKPro-Wrapper implements two base readers, one text reader and one XML-file reader. You can specify the reader that should be used with the <tt>-reader</tt> parameter. By default, the text reader is used. To use the XML reader, run the pipeline in the following way:</p></div>
<div class="sidebarblock">
<div class="content">
Expand All @@ -826,7 +826,7 @@ <h3 id="_text_reader_amp_xml_reader">Text Reader &amp; XML Reader</h3>
<div class="paragraph"><p>The XML reader skips XML tags and processes only text which is inside the XML tags. The xpath to each tag is conserved and stored in the column <strong>SectionId</strong> in the ouput format.</p></div>
</div>
<div class="sect2">
<h3 id="_reading_directories">Reading Directories</h3>
<h3 id="_reading_directories">5.2. Reading Directories</h3>
<div class="paragraph"><p>You can also specify for the <strong>-input</strong> argument a directory instead of a file. If you run the pipeline in the following way:</p></div>
<div class="sidebarblock">
<div class="content">
Expand All @@ -849,7 +849,7 @@ <h3 id="_reading_directories">Reading Directories</h3>
</div>
</div>
<div class="sect1">
<h2 id="_write_your_own_config_files">Write your own config files</h2>
<h2 id="_write_your_own_config_files">6. Write your own config files</h2>
<div class="sectionbody">
<div class="paragraph"><p>The pipeline can be configurated via properties-files that are stored in the <tt>configs</tt> folder. In this folder you find a <tt>default.properties</tt>, the most basic configuration file. For the different supported languages, you can find further properties-files, for example <tt>default_de.properties</tt> for German, <tt>default_es.properties</tt> for English and so on.</p></div>
<div class="paragraph"><p>If you like to write your own config file, just create your own <tt>.properties</tt> file. You can run the pipeline with your <tt>.properties</tt>-file by setting the command argument.</p></div>
Expand All @@ -876,7 +876,7 @@ <h2 id="_write_your_own_config_files">Write your own config files</h2>
<div class="paragraph"><p>In <tt>myPOSTagger.properties</tt> you just add the configuration for the different POS-tagger.</p></div>
<div class="paragraph"><p><strong>Note:</strong> The properties-files must use the ISO-8859-1 encoding. If you like to include UTF-8 characters, you must encode them using \u[HEXCode].</p></div>
<div class="sect2">
<h3 id="_understanding_the_argument_parameter">Understanding the Argument Parameter</h3>
<h3 id="_understanding_the_argument_parameter">6.1. Understanding the Argument Parameter</h3>
<div class="paragraph"><p>Most components can be equipped with arguments so specifcy for example the model that should be used. Arguments are passed to the pipeline in a 3 tuple format. In the <tt>default.properties</tt> you can find the following line:</p></div>
<div class="listingblock">
<div class="content">
Expand All @@ -887,11 +887,11 @@ <h3 id="_understanding_the_argument_parameter">Understanding the Argument Parame
</div>
</div>
<div class="sect1">
<h2 id="_using_treetagger">Using Treetagger</h2>
<h2 id="_using_treetagger">7. Using Treetagger</h2>
<div class="sectionbody">
<div class="paragraph"><p>Due to copyright issues, TreeTagger cannot directly be accessed from the DKPro repository. Instead, you have first to download and to install TreeTagger to able to use it with DKPro.</p></div>
<div class="sect2">
<h3 id="_treetagger_installation_for_linux">TreeTagger Installation for Linux</h3>
<h3 id="_treetagger_installation_for_linux">7.1. TreeTagger Installation for Linux</h3>
<div class="ulist"><ul>
<li>
<p>
Expand Down Expand Up @@ -935,7 +935,7 @@ <h3 id="_treetagger_installation_for_linux">TreeTagger Installation for Linux</h
</ul></div>
</div>
<div class="sect2">
<h3 id="_treetagger_installation_for_windows_7">TreeTagger Installation for Windows 7</h3>
<h3 id="_treetagger_installation_for_windows_7">7.2. TreeTagger Installation for Windows 7</h3>
<div class="ulist"><ul>
<li>
<p>
Expand Down Expand Up @@ -989,7 +989,7 @@ <h3 id="_treetagger_installation_for_windows_7">TreeTagger Installation for Wind
</ul></div>
</div>
<div class="sect2">
<h3 id="_configuration_of_the_pipeline">Configuration of the pipeline</h3>
<h3 id="_configuration_of_the_pipeline">7.3. Configuration of the pipeline</h3>
<div class="paragraph"><p>After downloading the correct executable and correct model, we must configure our pipeline in order to be able to use Treetagger. You can find an example configuration in the <em>configs</em> folder <em>treetagger-example.properties</em>:</p></div>
<div class="listingblock">
<div class="content">
Expand Down

0 comments on commit 87131eb

Please sign in to comment.