Add hint for CamelCase word breaks to search documentation

Pushed-by: Rene Pfeuffer<rene.pfeuffer@cloudogu.com>
Co-authored-by: René Pfeuffer<rene.pfeuffer@cloudogu.com>
This commit is contained in:
Rene Pfeuffer
2024-10-10 13:36:14 +02:00
parent 9458514129
commit 2162b0bc41
4 changed files with 39 additions and 2 deletions

View File

@@ -14,7 +14,15 @@
* along with this program. If not, see https://www.gnu.org/licenses/.
*/
export default `## Modifikatoren
export default `## Aufteilug von Wörtern
Der SCM-Manager ist für Code entwickelt und in Code verwendet man oft "CamelCase" Wörter. Um die Suche nach diesen Wörtern
zu erleichtern, werden sie für die Suche in separate Wörter aufgeteilt. Das bedeutet, dass die Suche nach \`SomeManager\`
auch den Begriff \`SomeRepositoryManager\` findet. Wenn Sie dies vermeiden möchten, können Sie Ihre Wörter einfach nur
in Kleinbuchstaben eingeben. Im obigen Beispiel findet die Suche nach \`somemanager\` nur den Begriff \`SomeManager\`,
aber nicht \`SomeRepositoryManager\`.
## Modifikatoren
Hinweis: Sie können keine Wildcards als erstes Zeichen einer Suche verwenden.
@@ -70,6 +78,8 @@ Die Suche unterstützt die Verwendung von Klammern zur Gruppierung von Begriffen
Eine Phrase ist eine Gruppe von Begriffen in einer bestimmten Reihenfolge. Falls man nach einer bestimmten Phrase suchen will, dann kann der \`"\`-Operator genutzt werden.
Bitte beachten Sie, dass Wörter getrennt werden, wenn sie "CamelCase" verwenden (wie im Abschnitt "Aufteilug von Wörtern" erwähnt), auch wenn sie mit \`"\` umschlossen sind.
|Definition|Beispiel|
|----------|--------|
|"" - Begriffe innerhalb der Anführungszeichen werden als Phrase gesucht|"Ultimate Repository" findet \`Ultimate Repository\` aber nicht \`Repository Ultimate\`, \`Ultimate\` oder \`Repository\`|