| Akron | 0c41ab3 | 2020-09-29 07:33:33 +0200 | [diff] [blame] | 1 | =pod |
| 2 | |
| 3 | =encoding utf8 |
| 4 | |
| 5 | =head1 NAME |
| 6 | |
| 7 | tei2korapxml - Conversion of TEI P5 based formats to KorAP-XML |
| 8 | |
| 9 | =head1 SYNOPSIS |
| 10 | |
| 11 | cat corpus.i5.xml | tei2korapxml > corpus.korapxml.zip |
| 12 | |
| 13 | =head1 DESCRIPTION |
| 14 | |
| 15 | C<tei2korapxml> is a script to convert TEI P5 and |
| 16 | L<I5|https://www1.ids-mannheim.de/kl/projekte/korpora/textmodell.html> |
| 17 | based documents to the |
| 18 | L<KorAP-XML format|https://github.com/KorAP/KorAP-XML-Krill#about-korap-xml>. |
| 19 | If no specific input is defined, data is |
| 20 | read from C<STDIN>. If no specific output is defined, data is written |
| 21 | to C<STDOUT>. |
| 22 | |
| 23 | This program is usually called from inside another script. |
| 24 | |
| 25 | =head1 FORMATS |
| 26 | |
| 27 | =head2 Input restrictions |
| 28 | |
| 29 | =over 2 |
| 30 | |
| 31 | =item |
| 32 | |
| 33 | utf8 encoded |
| 34 | |
| 35 | =item |
| 36 | |
| 37 | TEI P5 formatted input with certain restrictions: |
| 38 | |
| 39 | =over 4 |
| 40 | |
| 41 | =item |
| 42 | |
| 43 | B<mandatory>: text-header with integrated textsigle, text-body |
| 44 | |
| 45 | =item |
| 46 | |
| 47 | B<optional>: corp-header with integrated corpsigle, |
| 48 | doc-header with integrated docsigle |
| 49 | |
| 50 | =back |
| 51 | |
| 52 | =item |
| 53 | |
| 54 | All tokens inside the primary text may not be |
| 55 | newline seperated, because newlines are removed |
| 56 | (see L<KorAP::XML::TEI::Data>) and a conversion of newlines |
| 57 | into blanks between 2 tokens could lead to additional blanks, |
| 58 | where there should be none (e.g.: punctuation characters like C<,> or |
| 59 | C<.> should not be seperated from their predecessor token). |
| 60 | (see also code section C<~ whitespace handling ~>). |
| 61 | |
| 62 | =back |
| 63 | |
| 64 | =head2 Notes on the output |
| 65 | |
| 66 | =over 2 |
| 67 | |
| 68 | =item |
| 69 | |
| 70 | zip file output (default on C<stdout>) with utf8 encoded entries |
| 71 | (which together form the KorAP-XML format) |
| 72 | |
| 73 | =back |
| 74 | |
| 75 | =head1 INSTALLATION |
| 76 | |
| 77 | C<tei2korapxml> requires L<libxml2-dev> bindings to build. When |
| 78 | these bindings are available, the preferred way to install the script is |
| 79 | to use L<cpanm|App::cpanminus>. |
| 80 | |
| 81 | $ cpanm https://github.com/KorAP/KorAP-XML-TEI.git |
| 82 | |
| 83 | In case everything went well, the C<tei2korapxml> tool will |
| 84 | be available on your command line immediately. |
| 85 | |
| 86 | Minimum requirement for L<KorAP::XML::TEI> is Perl 5.16. |
| 87 | |
| 88 | =head1 OPTIONS |
| 89 | |
| 90 | =over 2 |
| 91 | |
| 92 | =item B<--root|-r> |
| 93 | |
| 94 | The root directory for output. Defaults to C<.>. |
| 95 | |
| 96 | =item B<--help|-h> |
| 97 | |
| 98 | Print help information. |
| 99 | |
| 100 | =item B<--version|-v> |
| 101 | |
| 102 | Print version information. |
| 103 | |
| 104 | =item B<--tokenizer-call|-tc> |
| 105 | |
| 106 | Call an external tokenizer process, that will tokenize |
| 107 | a single line from STDIN and outputs one token per line. |
| 108 | |
| 109 | =item B<--tokenizer-korap|-tk> |
| 110 | |
| 111 | Use the standard KorAP/DeReKo tokenizer. |
| 112 | |
| Akron | 6d7b8e4 | 2020-09-29 07:37:41 +0200 | [diff] [blame] | 113 | =item B<--tokenizer-internal|-ti> |
| Akron | 0c41ab3 | 2020-09-29 07:33:33 +0200 | [diff] [blame] | 114 | |
| 115 | Tokenize the data using two embedded tokenizers, |
| 116 | that will take an I<Aggressive> and a I<conservative> |
| 117 | approach. |
| 118 | |
| 119 | =item B<--log|-l> |
| 120 | |
| 121 | Loglevel for I<Log::Any>. Defaults to C<notice>. |
| 122 | |
| 123 | =back |
| 124 | |
| Akron | b364947 | 2020-09-29 08:24:46 +0200 | [diff] [blame^] | 125 | =head1 ENVIRONMENT VARIABLES |
| 126 | |
| 127 | =over 2 |
| 128 | |
| 129 | =item B<KORAPXMLTEI_DEBUG> |
| 130 | |
| 131 | Activate minimal debugging. |
| 132 | Defaults to C<false>. |
| 133 | |
| 134 | =item B<KORAPXMLTEI_INLINE> |
| 135 | |
| 136 | Process inline annotations, if present. |
| 137 | Defaults to C<false>. |
| 138 | |
| 139 | =back |
| 140 | |
| Akron | 0c41ab3 | 2020-09-29 07:33:33 +0200 | [diff] [blame] | 141 | =head1 COPYRIGHT AND LICENSE |
| 142 | |
| 143 | Copyright (C) 2020, L<IDS Mannheim|https://www.ids-mannheim.de/> |
| 144 | |
| 145 | Author: Peter Harders |
| 146 | |
| Akron | aabd095 | 2020-09-29 07:35:08 +0200 | [diff] [blame] | 147 | Contributors: Nils Diewald, Marc Kupietz, Carsten Schnober |
| Akron | 0c41ab3 | 2020-09-29 07:33:33 +0200 | [diff] [blame] | 148 | |
| 149 | L<KorAP::XML::TEI> is developed as part of the L<KorAP|https://korap.ids-mannheim.de/> |
| 150 | Corpus Analysis Platform at the |
| 151 | L<Leibniz Institute for the German Language (IDS)|http://ids-mannheim.de/>, |
| 152 | member of the |
| 153 | L<Leibniz-Gemeinschaft|http://www.leibniz-gemeinschaft.de/>. |
| 154 | |
| 155 | This program is free software published under the |
| 156 | L<BSD-2 License|https://raw.githubusercontent.com/KorAP/KorAP-XML-TEI/master/LICENSE>. |
| 157 | |
| 158 | =cut |