zoterobib

Zotero-Lätzchen

Überblick

Dieses Repo enthält Code für Zotero Bib, einschließlich React-Komponenten, Übersetzungsclient, Stylesheets und Einstiegspunkt-Website.

Voraussetzungen

1. Knoten JS mit npm
2. Grundlegende Befehlszeilentools, einschließlich rsync
3. Vorhandener Übersetzungsserver
4. Vorhandener Bib-Server
5. Bestehende Stile-Repo

Lokale Entwicklungsversion

Die Bibliothek bekommen

1. git clone --recursive [email protected]:zotero/zoterobib.git

2. cd zoterobib

3. npm install

4. npm start

Dies wird als Demo auf http://127.0.0.1:8001 bereitgestellt.

Möglicherweise müssen Sie Konfigurationsoptionen bereitstellen (siehe unten), damit die Speicherung und Übersetzung funktioniert.

Standardmäßig leitet der Entwicklungsserver Übersetzungsserveranfragen an localhost:1969 weiter . Wenn sich Ihr Server an einem anderen Ort befindet, müssen Sie die URL angeben. Der letzte Schritt oben würde beispielsweise so aussehen:

1. TRANSLATE_URL=http://localhost:1234 npm start

Dadurch werden Anfragen vom Browser an den angegebenen Übersetzungsserver weitergeleitet.

Verwendung in der Produktion

Um produktionsbereite Dateien zu erhalten, verwenden Sie den folgenden npm-Befehl:

npm run build

Konfiguration

Es ist möglich, Konfigurationsparameter für den Build (sowohl in der Entwicklung als auch in der Produktion) mithilfe von Konfigurationsdateien und/oder Umgebungsvariablen bereitzustellen.

Der einfachste Weg besteht darin, config/default.json nach config/local.json zu kopieren und dort Variablen zu platzieren (diese Datei wird von Git ignoriert und sollte nicht festgeschrieben werden). Alternativ können Umgebungsvariablen verwendet werden, die in config/custom-environment-variables.json aufgeführt sind. Weitere Informationen zum Bereitstellen von Konfigurationen finden Sie unter config npm package.

Konfigurationsoptionen

Folgende Konfigurationsmöglichkeiten werden akzeptiert:

storeURL Gibt die URL für die Bib-Server- API an, in der Bibliografien gespeichert werden.

stylesURL Gibt die URL für die Styles-Repo- Website an. Wenn es leer bleibt, wird die Standardeinstellung https://www.zotero.org/styles-files/styles.json verwendet

TranslatePrefix Gibt ein zusätzliches Präfix dafür an, wohin die Übersetzungsserveranfrage gesendet werden soll. Nützlich in Fällen, in denen translateURL leer bleibt, damit es möglich ist, Anfragen an einen bestimmten Endpunkt an dem Ort zu leiten, an dem zotero-bib gehostet wird.

TranslateURL Gibt die URL für den Übersetzungsserver an. Standardmäßig wird davon ausgegangen, dass localhost die Anfrage an den Übersetzungsserver weiterleitet.

apiAuthorityPart Gibt den Autoritätsteil der URL für Zotero-API-Anfragen an. Standardmäßig ist api.zotero.org .

Konfiguration des Entwicklungsservers

Das Ausführen npm start für die folgenden Umgebungsvariablen:

TRANSLATE_URL Wohin Übersetzungsanfragen weitergeleitet werden sollen, standardmäßig ist http://localhost:1969. Standardmäßig sendet ZoteroBib Übersetzungsanfragen an window.location.origin und der Entwicklungsserver sollte so konfiguriert sein, dass er diese Anfragen an einen Übersetzungsserver weiterleitet.

PORT Auf welchem ​​Port der Entwicklungsserver horchen soll, ist standardmäßig 8001.

NO_HYDRATE Beim Zugriff auf eine Remote-Bibliographie kann ZoteroBib aus vorgerendertem HTML hydratisieren, um einen Spinner beim Laden zu vermeiden. Zu Entwicklungszwecken wird in hydrate.hbs eine hartcodierte Bibliographie gespeichert und zur Bearbeitung aller Anfragen verwendet, die eine Remote-Bibliographie-ID enthalten. Um dieses Verhalten zu deaktivieren, setzen Sie NO_HYDRATE auf 1 , wodurch stattdessen index.hbs bereitgestellt wird, was bedeutet, dass die Bibliographie immer clientseitig mit einem Spinner gerendert wird.