Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,059 of 9,059 pages
About the help in other languages
All help pages

exp:exphelp

Das Hilfesystem auf der Kommandozeile: den Index von doc/ aufbauen und beschreiben, darin suchen, die Metadaten einer Seite zeigen, ihre Links und Bilder prüfen.

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/examples/commands/exphelp.md

On this page

This page is a translation. Read the English original

exp:exphelp

Das Hilfesystem auf der Kommandozeile: den Index von doc/ aufbauen und beschreiben, darin suchen, die Metadaten einer Seite zeigen, ihre Links und Bilder prüfen.

Skript bin/php/exphelp.php, Code in kernel/private/classes/commands/exphelp.php. Führen Sie es im Wurzelverzeichnis der Installation aus, als der Benutzer, unter dem der Webserver läuft:

./console exp:exphelp --help
./console exp:help --help
php bin/php/exphelp.php --help

Hilfetext

Was --help ausgibt, so wie der Befehl es schreibt:

The help system: the index of the documentation, its search and its link check

./console exp:help index                     build the index (if it is not current) and describe it
./console exp:help index --rebuild           build it again, whatever is cached
./console exp:help index --list              one line per page: id, type, category, audiences, title
./console exp:help index --no-images         without fetching the pages' external images
./console exp:help search "clear cache"      search the pages (--audience, --category, --type, --limit)
./console exp:help show guides/caches.md     the metadata and headings of one page
./console exp:help check                     check the links and images of every page (--below=guides/)
./console exp:help pdf help/searching.md      the page as a PDF file (--out=file.pdf, --base-url=https://host)
./console exp:help maps --language=ger-de    check doc/ger-de/.paths.json and .dirnames.json; --fix writes the
                                             union of both sides of a git conflict (and of --paths=, --dirnames=)

Only git-tracked files below doc/ (and the doc/ of the extensions in exphelp.ini ExtensionDocDirs[]) are
pages; nothing is changed except the cache in var/<site>/cache/exphelp. --json prints one JSON document.
index builds the index of every language of exphelp.ini [DocLanguages] (doc/eng-us/, doc/ger-de/ ...);
--language=ger-de limits it to one, and makes search, show, check and pdf read that language.
index also stores a copy of every https image a page shows (README.md's screenshots) in the cache's
images/, served by exphelp/image, so the admin's Content Security Policy allows them.
Exit code: 0 fine, 1 check found errors (with --strict also warnings) or nothing was found, 2 error.

Optionen

OptionWertHilfe
--rebuildindex: den Index neu aufbauen, auch wenn der im Cache aktuell ist
--listindex: jede Seite auflisten
--no-imagesindex: die externen Bilder der Seiten nicht abrufen (sie bleiben Links)
--keep-searchindex: einen aktuellen Suchindex behalten, statt ihn neu zu bauen (den Bau im Hintergrund, den eine Hilfeseite startet)
--jsonEin JSON-Dokument statt des Textes ausgeben
--audienceerforderlichsearch, index --list: nur Seiten für diese Zielgruppe (editor, admin, developer, user)
--categoryerforderlichsearch, index --list: nur Seiten dieser Kategorie
--typeerforderlichsearch, index --list: nur Seiten dieses Typs (guide, feature, bc, changelog ...)
--limiterforderlichsearch: die Anzahl der Ergebnisse (Standard 10)
--belowerforderlichcheck, index --list: nur die Seiten, deren ID damit beginnt (z. B. guides/)
--allcheck: auch die Hinweise auflisten (Links auf Dateien, die keine Hilfeseiten sind)
--strictcheck: auch bei Warnungen Exit-Code 1
--outerforderlichpdf: die zu schreibende Datei (Standard: der Seitentitel als Dateiname, im aktuellen Verzeichnis)
--base-urlerforderlichpdf: Schema und Host für die Links und die Adresse der Seite (https://www.example.com)
--languageerforderlichdie Sprache der Dokumentation: ein Verzeichnis aus exphelp.ini [DocLanguages] Directories[] (eng-us, ger-de; die alten en/us und de werden akzeptiert)
--fixmaps: .paths.json und .dirnames.json als Vereinigung ihrer Einträge schreiben, sortiert
--pathserforderlichmaps --fix: außerdem die Einträge dieser JSON-Datei in .paths.json übernehmen
--dirnameserforderlichmaps --fix: außerdem die Einträge dieser JSON-Datei in .dirnames.json übernehmen

Aus den Optionsdefinitionen im Code gelesen (startup(), getOptions(), options() oder ezcConsoleOption). Jedes Skript nimmt außerdem die Standardoptionen des Skript-Frameworks (--help, --siteaccess, --debug, --quiet, --allow-root-user ...).

Siehe auch


Erzeugt von ./console exp:help:examples --language=ger-de aus bin/php/exphelp.php, kernel/private/classes/commands/exphelp.php. Bearbeiten Sie diese Seite nicht: Ändern Sie die Quelle oder die deutsche Übersetzung und erzeugen Sie sie neu (wie). Freie Dokumentation: GFDL 1.3 oder später.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x