Struki Hilfe

Allgemeine Informationen

Bitte beachten Sie! Um einen Missbrauch dieser Demo zu verhindern, werden zufällige Elemente bei der Ausgabe der strukturierten Variante unkenntlich gemacht ausgegeben.

Um diese Einschränkung zu umgehen, können Sie gern den entsprechenden Code bei Jan Schilbach jan.schilbach@le-tex.de erfragen.

Struki Informationen

Strukturieren von Referenzdateien

Beispielvideo

Video (MKV)

Video (MP4)

Beispieldateien

XML-Dokument (ltxref-Format)

Word-Dokument

Formate

Als mögliche Eingangsformate aktzeptiert Struki aktuell

LTX-Ref: Ein le-tex eigenes XML-Format zur Darstellung von strukturierten Literaturangaben. Ein simples Beispiel:/p>
<?xml version="1.0" encoding="UTF-8"?>
<References ID="Bib1">
   <Heading>Literatur</Heading>
   <Reference ID="CR1">
     <Unstructured>Jan Schilbach: Strukturierte Referenzen mit Struki (2014, <i>le-tex</i>), <b>Leipzig</b>.</Unstructured>
   </Reference>
</References>

Das Schema für ltx-ref findet sich hier: Schema-Zip
docx: Word-Dateien im docx-Format. Die Referenzen müssen die Absatzformatvorlage "References" tragen.
HTML-Input: Eingabe über den Online-Editor. Hierbei muss jede Referenz auf einer Zeile stehen.

Ablauf

Nach dem Hochladen der Datei wird das Ergebnis der Vorstrukturierung dargestellt.
Der erkannte Referenztyp wird durch ein aktiviertes Kästchen links oben dargestellt. Wurde dieser falsch erkannt, kann er durch Anklicken des richtigen Types korrigiert werden.
In der Literaturreferenz werden die verschiedenen Bestandteile farblich hervorgehoben.
Sollten Teile falsch erkannt worden sein, kann der Nutzer hier eingreifen. Dazu wird eine zuzuweisende Stelle mit Hilfe der Standard-Markierfunktion des Browsers ausgewählt. Danach wird durch Anklicken des farbigen Buttons neben der korrekten Auszeichnung der entsprechende Text markiert.
Weitere Anpassungen können danach direkt in der Maske unten vorgenommen werden.
Mit den Symbolen "+" und "#" kann zwischen den Literaturreferenzen hin- und hergesprungen werden.
Nach dem Prüfen und Korrigieren aller Literaturreferenzen kann unter "Aktion" zwischen "Formatierung" und "Export" gewählt werden. "Formatierung" gibt dem Nutzer die Möglichkeit, automatisch formatierte Literaturreferenzen aus den strukturierten Daten zu erzeugen. Hierfür stehen mehrere Stile zur Auswahl. "Export" exportiert die Datei mit Strukturinformationen im hochgeladenen Format.

Tastenkürzel

Es stehen verschiedene Tastenkürzel bereit, die beim Auszeichnen und Navigieren helfen.

Navigation

+	Nächste Literaturreferenz
#	Vorherige Literaturreferenz

Typumstellung

1	Als Buch strukturieren
2	Als Kapitel strukturieren
3	Als Artikel strukturieren
4	Als Webseite strukturieren
5	Unstrukturiert belassen

Markieren von Bestandteilen

Hier zeigt der einzelne Buchstabe in der Maske an, welche Taste die entsprechende Markierung auslöst.

REST-Schnittstelle

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

Der Aufruf dient dazu, die Strukturierung einer Literaturreferenzdatei vorzubereiten. Es werden drei URLs zurückgegebenen, mit denen der Nutzer entscheiden kann, ob er das finale Ergebnis direkt abrufen möchte, oder ob er vorher noch eine Sichtprüfung und eventuelle Korrekturen vornehmen möchte.

Mögliche Werte:

input_format: ltx, app, docx

output_format: ltx, app, docx (docx output nur verfügbar bei docx input)

ref_style_language: en|de

format: xml, json

Die zu strukturierende Datei muss als Parameter mit dem Namen "file" hochgeladen werden.

Ergebnis: Im gewählten Format werden drei verschiedene URLs zurückgegeben.

Beispiel JSON:

				{
				
				   "manual_edit": http://strukidemo/structuring/structure/e25531dd7d41db9f96a3cf0a4dc4266accc6b171,

				   "check": http://strukidemo/structuring/show_demo_page/e25531dd7d41db9f96a3cf0a4dc4266accc6b171,

				   "final": http://strukidemo/structuring/finalize/e25531dd7d41db9f96a3cf0a4dc4266accc6b171

				}

Die manual_edit-URL gibt an, wo die manuelle Strukturierung aufgerufen werden kann. Die check-URL gibt an, wo das finale Ergebnis geprüft werden kann, hier kann auch noch der Literaturreferenzstil angepasst werden. Die final-URL gibt an, wo die finale Datei abgerufen werden kann. Die XML-Repräsentation funktioniert analog.

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

Der Aufruf dient dazu eine einzelne Literaturreferenz zu strukturieren. In Abhängigkeit des output_type-Parameters wird entweder das XML der strukturierten Literaturreferenz oder eine URL zurückgegeben.

Mögliche Werte

input_type: xml, string

output_type: all, best, manual_url

format: xml

Die zu strukturierende Literaturreferenz muss als Parameter mit dem Namen "reference" gepostet werden.

Ergebnis: Bei "all" werden alle von Struki gefundenen Möglichkeiten, die Literaturreferenz zu strukturieren zurückgeliefert. Bei "best" wird nur die am besten bewertete Möglichkeit, die Literaturreferenz zu strukturieren zurückgeliefert. Bei "manual_url" wird ein Link auf die Möglichkeit zur manuellen Strukturierung zurückgeliefert.