--- title: "User Manual" manual: "Kitodo.Presentation" version: "dev-demo" source: "User/Index.rst" rendered: "2026-09-27T16:21:24+00:00" --- # User Manual {#user-manual} - [Indexing Documents](#indexing-documents) - [Indexing full texts](#indexing-full-texts) ## Indexing Documents {#indexing-documents} New documents may be indexed via the TYPO3 command line interface (CLI). ### Index single document {#index-single-document} The command `kitodo:index` is used for indexing a single document: ```php ./vendor/bin/typo3 kitodo:index -d http://example.com/path/mets.xml -p 123 -s dlfCore1 ``` | Option | Required | Description | Example | | --- | --- | --- | --- | | `-d\|--doc` | yes | This may be an UID of an existing document in `tx_dlf_documents` or the URL of a METS XML file. If the URL is already known as location in `tx_dlf_documents`, the file is processed anyway and the records in database and solr index are updated. Hint: Do not encode the URL! If you have spaces in path, use quotation marks. | 123 or [http://example.com/path/mets.xml](http://example.com/path/mets.xml) | | `-p\|--pid` | yes | The page UID of the Kitodo.Presentation data folder. This keeps all records of documents, metadata, structures, solrcores etc. | 123 | | `-s\|--solr` | yes | This may be the UID of the solrcore record in `tx_dlf_solrcores`. Alternatively you may write the index name of the solr core. The solr core must exist in table tx_dlf_solrcores on page "pid". Otherwise an error is shown and the processing won't start. | 123 or 'dlfCore1' | | `-o\|--owner` | no | This may be the UID of the library record in `tx_dlf_libraries` which should be set as the owner of the document. If omitted, the default is to try to read the ownership from the metadata field "owner". | 123 | | `--dry-run` | no | Nothing will be written to database or index. The solr-setting will be checked and the documents location URL will be shown. | | | `--softCommit` | no | The document is added to the index by a soft commit instead of a hard commit, which is faster but makes the document visible to searches only after a later hard commit or index optimization. | | | `-q\|--quiet` | no | Do not output any message. Useful when using a wrapper script. The script may check the return value of the CLI job. This is always 0 on success and 1 on failure. | | | `-v\|--verbose` | no | Show processed documents uid and location with indexing parameters. | | ### Reindex collections {#reindex-collections} With the command `kitodo:reindex` it is possible to reindex one or more collections or even to reindex all documents on the given page.: ```php # reindex collection with uid 1 on page 123 with solr core 'dlfCore1' # short notation ./vendor/bin/typo3 kitodo:reindex -c 1 -p 123 -s dlfCore1 # long notation ./vendor/bin/typo3 kitodo:reindex --coll 1 --pid 123 --solr dlfCore1 # reindex collection with uid 1 on page 123 with solr core 'dlfCore1' in given range # short notation ./vendor/bin/typo3 kitodo:reindex -c 1 -l 1000 -b 0 -p 123 -s dlfCore1 ./vendor/bin/typo3 kitodo:reindex -c 1 -l 1000 -b 1000 -p 123 -s dlfCore1 # long notation ./vendor/bin/typo3 kitodo:reindex --coll 1 --index-limit=1000 --index-begin=0 --pid 123 --solr dlfCore1 ./vendor/bin/typo3 kitodo:reindex --coll 1 --index-limit=1000 --index-begin=1000 --pid 123 --solr dlfCore1 # reindex collection with uid 1 and 4 on page 123 with solr core 'dlfCore1' # short notation ./vendor/bin/typo3 kitodo:reindex -c 1,4 -p 123 -s dlfCore1 # long notation ./vendor/bin/typo3 kitodo:reindex --coll 1,4 --pid 123 --solr dlfCore1 # reindex collection with uid 1 and 4 on page 123 with solr core 'dlfCore1' in given range # short notation ./vendor/bin/typo3 kitodo:reindex -c 1,4 -l 1000 -b 0 -p 123 -s dlfCore1 ./vendor/bin/typo3 kitodo:reindex -c 1,4 -l 1000 -b 1000 -p 123 -s dlfCore1 # long notation ./vendor/bin/typo3 kitodo:reindex --coll 1,4 --index-limit=1000 --index-begin=0 --pid 123 --solr dlfCore1 ./vendor/bin/typo3 kitodo:reindex --coll 1,4 --index-limit=1000 --index-begin=1000 --pid 123 --solr dlfCore1 # reindex all documents on page 123 with solr core 'dlfCore1' (caution can result in memory problems for big amount of documents) # short notation ./vendor/bin/typo3 kitodo:reindex -a -p 123 -s dlfCore1 # long notation ./vendor/bin/typo3 kitodo:reindex --all --pid 123 --solr dlfCore1 # reindex all documents on page 123 with solr core 'dlfCore1' in given range # short notation ./vendor/bin/typo3 kitodo:reindex -a -l 1000 -b 0 -p 123 -s dlfCore1 ./vendor/bin/typo3 kitodo:reindex -a -l 1000 -b 1000 -p 123 -s dlfCore1 # long notation ./vendor/bin/typo3 kitodo:reindex --all --index-limit=1000 --index-begin=0 --pid 123 --solr dlfCore1 ./vendor/bin/typo3 kitodo:reindex --all --index-limit=1000 --index-begin=1000 --pid 123 --solr dlfCore1 ``` | Option | Required | Description | Example | | --- | --- | --- | --- | | `-a\|--all` | no | With this option, all documents from the given page will be reindex. | | | `-c\|--coll` | no | This may be a single collection UID or a list of UIDs to reindex. | 1 or 1,2,3 | | `-p\|--pid` | yes | The page UID of the Kitodo.Presentation data folder. This keeps all records of documents, metadata, structures, solrcores etc. | 123 | | `-s\|--solr` | yes | This may be the UID of the solrcore record in `tx_dlf_solrcores`. Alternatively you may write the index name of the solr core. The solr core must exist in table tx_dlf_solrcores on page "pid". Otherwise an error is shown and the processing won't start. | 123 or 'dlfCore1' | | `-o\|--owner` | no | This may be the UID of the library record in `tx_dlf_libraries` which should be set as the owner of the documents. If omitted, the default is to try to read the ownership from the metadata field "owner". | 123 | | `-l\|--index-limit` | no | With this option, all documents in given limit for the given page will be reindex. Used when it is expected that memory problems can appear due to the high amount of documents. | 1000 | | `-b\|--index-begin` | no | With this option, all documents beginning from given value for the given page will be reindex. Used when it is expected that memory problems can appear due to the high amount of documents. | | | `-uc\|--use-cache` | no | If this option is set, the document will be taken from cache if a cache exists. | | | `--dry-run` | no | Nothing will be written to database or index. All documents will be listed which would be processed on a real run. | | | `--softCommit` | no | The documents are added to the index by a soft commit instead of a hard commit, which is faster but they are visible to searches only after a later hard commit or index optimization. | | | `-q\|--quiet` | no | Do not output any message. Useful when using a wrapper script. The script may check the return value of the CLI job. This is always 0 on success and 1 on failure. | | | `-v\|--verbose` | no | Show each processed documents uid and location with timestamp and amount of processed/all documents. | | ### Harvest OAI-PMH interface {#harvest-oai-pmh-interface} With the command `kitodo:harvest` it is possible to harvest an OAI-PMH interface and index all fetched records.: ```php # example ./vendor/bin/typo3 kitodo:harvest --owner= --pid= --solr= --from= --until= --set= ``` In order to use the command, you first have to configure a library in the backend, setting at least a label and oai_base. The latter should be a valid OAI-PMH base URL (e.g. [https://digital.slub-dresden.de/oai/](https://digital.slub-dresden.de/oai/)). | Option | Required | Description | Example | | --- | --- | --- | --- | | `-o\|--owner` | yes | This is the UID of the library record with the OAI interface that should be harvested. This library is also automatically set as the documents' owner. | 123 | | `-p\|--pid` | yes | This is the page UID of the library record and therefore the page the documents are added to. | 123 | | `-s\|--solr` | yes | This may be the UID of the solrcore record in `tx_dlf_solrcores`. Alternatively you may write the index name of the solr core. The solr core must exist in table tx_dlf_solrcores on page "pid". Otherwise an error is shown and the processing won't start. | 123 or 'dlfCore1' | | `--from` | no | This is a timestamp in the format YYYY-MM-DD. The parameters from and until limit harvesting to the given period, e.g. for incremental updates. | 2021-01-01 | | `--until` | no | This is a timestamp in the format YYYY-MM-DD. The parameters from and until limit harvesting to the given period, e.g. for incremental updates. | 2021-06-30 | | `--set` | no | This is the name of an OAI set. The parameter limits harvesting to the given set. | 'vd18' | | `--dry-run` | no | Nothing will be written to database or index. All documents will be listed which would be processed on a real run. | | | `--softCommit` | no | The documents are added to the index by a soft commit instead of a hard commit, which is faster but they are visible to searches only after a later hard commit or index optimization. | | | `-q\|--quiet` | no | Do not output any message. Useful when using a wrapper script. The script may check the return value of the CLI job. This is always 0 on success and 1 on failure. | | | `-v\|--verbose` | no | Show each processed documents uid and location with timestamp and amount of processed/all documents. | | ### Delete single document {#delete-single-document} The command `kitodo:delete` is used for deleting a single document: ```php ./vendor/bin/typo3 kitodo:delete -d http://example.com/path/mets.xml -p 123 -s dlfCore1 ``` | Option | Required | Description | Example | | --- | --- | --- | --- | | `-d\|--doc` | yes | This may be an UID of an existing document in `tx_dlf_documents` or the URL of a METS XML file. Hint: Do not encode the URL! If you have spaces in path, use quotation marks. | 123 or [http://example.com/path/mets.xml](http://example.com/path/mets.xml) | | `-p\|--pid` | yes | The page UID of the Kitodo.Presentation data folder. This keeps all records of documents, metadata, structures, solrcores etc. | 123 | | `-s\|--solr` | yes | This may be the UID of the solrcore record in `tx_dlf_solrcores`. Alternatively you may write the index name of the solr core. The solr core must exist in table tx_dlf_solrcores on page "pid". Otherwise an error is shown and the processing won't start. | 123 or 'dlfCore1' | | `--softCommit` | no | The deletion from the index is done by a soft commit instead of a hard commit, which is faster but the change is visible to searches only after a later hard commit or index optimization. | | ### Commit and/or optimize index {#commit-and-or-optimize-index} With the command `kitodo:optimize` it is possible to hard commit documents to and/or optimize the index.: ```php # example ./vendor/bin/typo3 kitodo:optimize --solr= --commit --optimize ``` | Option | Required | Description | Example | | --- | --- | --- | --- | | `-s\|--solr` | yes | This may be the UID of the solrcore record in `tx_dlf_solrcores`. Alternatively you may write the index name of the solr core. The solr core must exist in table tx_dlf_solrcores on page "pid". Otherwise an error is shown and the processing won't start. | 123 or 'dlfCore1' | | `--commit` | no | Hard commit documents to the index. | | | `--optimize` | no | Optimize the index. | | | `-q\|--quiet` | no | Do not output any message (standard Symfony option). | | | `-v\|--verbose` | no | Increase the verbosity of messages (standard Symfony option). | | ## Indexing full texts {#indexing-fulltexts} Full texts must be provided in the `FULLTEXT` file group within the METS. Kitodo.Presentation supports the ALTO and TEI format for indexing full texts. **ALTO** Each ALTO file contains the full text of a single page of the document. ```xml ... ``` **TEI** TEI contains all full texts of the entire document. ```xml ``` > [!NOTE] > The identifier of the `facsimile` tag (and thus the `pb` tag (page break) references) in the TEI must match the `ID` attribute of the `mets:div` with type `page` in the physical structMap of the METS. Otherwise, the pages cannot be mapped and will not be indexed. For indexing full texts, the formats need to be defined in the Data Formats or in the table `tx_dlf_formats` with following settings. | Format Name (e.g. in METS) | Root Element | Namespace URI | Class Name | | --- | --- | --- | --- | | ALTO | alto | [http://www.loc.gov/standards/alto/ns-v2#](http://www.loc.gov/standards/alto/ns-v2#) | `Kitodo\Dlf\Format\Alto` | | TEI | TEI | [http://www.tei-c.org/ns/1.0](http://www.tei-c.org/ns/1.0) | `Kitodo\Dlf\Format\Tei` | After configuration, all full texts will be indexed when executing the commands of [Indexing Documents](#indexing_documents).