Struki Help

General Information

Please take notice of the fact, that in order to prevent misuse of this demo, random elements of the output are scrambled.

To circumvent this restriction, please ask for the needed code at jan.schilbach@le-tex.de.

Struki Information

Structuring of Reference Files

Example Video

Video (MKV)

Video (MP4)

Example documents

XML document (ltxref format)

Word document

Formats

Possible struki input formats are:

LTX-Ref: a le-tex XML-Format for structured literature. A simple example:

<?xml version="1.0" encoding="UTF-8"?>
<References ID="Bib1">
   <Heading>Literature</Heading>
   <Reference ID="CR1">
     <Unstructured>Jan Schilbach: Strukturierte Literaturreferenzen mit Struki (2014, <i>le-tex</i>), <b>Leipzig</b>.</Unstructured>
   </Reference>
</References>

The format schema can be found here: Schema-Zip
docx: Word-Files in the docx format. The references need to have the "References" paragraph style.
HTML-Input: Input via online editor. Every reference has to be in one line.

Process

After uploading the file the result of the preprocessing is shown.
The recognized type is shown through an active box right of the reference. If the recognized type is wrong the user can correct it by pressing one of the other buttons.
The different recognized parts of the reference are color coded.
If parts of the reference are assigned wrong, the user can correct them to. In order to do this the part is marked via the standard marking mechanism of the browser. Afterwards the colored button left of the right type is pressed.
Further corrections and changes can be done in the form.
With the arrows on the top left the user can switch between references.
After checking and correcting all references the user can choose between "Format" and "Export" in the "Action" drop down. "Format" enables the user to examine the references in different reference styles and export the references in this style. "Export" exports the file in the uploaded format with the structure informations.

Shortcuts

Multiple shortcuts are available, to help marking and navigating inside the manual structuring.

Navigation

+	Next reference
#	Previous reference

Select type

1	structure as book
2	structure as chapter
3	structure as article
4	structure as website
5	leave unstructured

Marking reference parts

The letter besides the element shows the shortcut for marking the respective type.

REST-Interface

Structuring multiple references

post "rest/structure/file/:input_format/:output_format(/:ref_style)(/:ref_style_language)(.:format)"

The call is intended to prepare the structuring of a file with multiple references. A set of URLs is returned, where the user can choose, whether to directly download the final result or to check and manually edit the automatically generated results.

Possible values

input_format: ltx, app, docx

output_format: ltx, app, docx (docx output only available with docx input)

ref_style_language: en|de

format: xml, json

The file to be structured has to be posted as "file" parameter.

Result: In the chosen format two URLs are returned.

Example JSON:

{
"manual_edit": http://strukidemo/structuring/structure/e25531dd7d41db9f96a3cf0a4dc4266accc6b171,
"check": http://strukidemo/structuring/show_demo_page/e25531dd7d41db9f96a3cf0a4dc4266accc6b171,
"final": http://strukidemo/structuring/finalize/e25531dd7d41db9f96a3cf0a4dc4266accc6b171
}

The manual_edit-URL shows the URL where the manual structuring of the uploaded file can be accessed. The check-URL shows, where the final result can be checked. Here the reference style and language can be changed. The final-URL shows, where the result can be downloaded. The XML format works analogously.

Structuring a single reference

post "rest/structure/reference/(:input_type)/(:output_type)(.:format)"

The call is intended to structure a single reference. The XML of the structure result or if manual_url is choosen an URL is returned.

Possible values

input_type: xml, string

output_type: all, best, manual_url

format: xml

The reference to be structured has to be posted as "reference" parameter.

Result: "all" returns all possibilities struki found to structure the reference. "best" returns only the possiblity struki considers best. "manual_url" returns the url where the manual structuring can be reached.