From 2162b0bc414e842934b9b7a6bf1ea72140a5bde6 Mon Sep 17 00:00:00 2001 From: Rene Pfeuffer Date: Thu, 10 Oct 2024 13:36:14 +0200 Subject: [PATCH] Add hint for CamelCase word breaks to search documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Pushed-by: Rene Pfeuffer Co-authored-by: René Pfeuffer --- docs/de/user/search/index.md | 10 ++++++++++ docs/en/user/search/index.md | 8 ++++++++ scm-ui/ui-api/src/help/search/syntax.de.ts | 12 +++++++++++- scm-ui/ui-api/src/help/search/syntax.en.ts | 11 ++++++++++- 4 files changed, 39 insertions(+), 2 deletions(-) diff --git a/docs/de/user/search/index.md b/docs/de/user/search/index.md index cf19eea7c6..08091d447e 100644 --- a/docs/de/user/search/index.md +++ b/docs/de/user/search/index.md @@ -15,6 +15,14 @@ Jeder Suchbegriff einer einfachen Suche wird implizit am Ende mit dem \*-Operato Die zweite Art von Suche ist die Expertensuche. Sobald eine Suchanfrage einen Operator beinhaltet, dann gilt diese Suchanfrage als Expertensuche. Die Art von Suche ermöglicht es, komplexe Suchabfragen zu erstellen. Allerdings werden Suchbegriffe hier nicht implizit mit einem \*-Operator erweitert. Dementsprechend muss hier der \*-Operator bei Bedarf explizit gesetzt werden. +## 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. @@ -71,6 +79,8 @@ Definition | Beispiel Eine Phrase ist eine Gruppe von Begriffen in einer bestimmten Reihenfolge. Wenn Sie nach bestimmten Phrasen suchen möchten, können Sie das " Zeichen verwenden. +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` diff --git a/docs/en/user/search/index.md b/docs/en/user/search/index.md index 74f052e27f..051d8f1b40 100644 --- a/docs/en/user/search/index.md +++ b/docs/en/user/search/index.md @@ -11,6 +11,12 @@ Every term used in a simple query get implicitly extended with the \* operator a The second type of query is the expert query. Any query that contains at least one operator is considered as an expert query. This query type allows for complex searches. But terms used in the expert query are not extended with the \* implicitly. A user has to add them explicitly to a term. +### Word Split + +SCM-Manager is built for code, and in code one often uses "CamelCase" words. To make it easier to search for these words, +we split them into separate words. This means that searching for `SomeManager` will also match the term +`SomeRepositoryManager`. If you want to avoid this, you can simply type your words in small letters only. In the example +above, searching for `somemanager` will only match the term `SomeManager` but not `SomeRepositoryManager`. ### Modifiers Note: You can not use wildcards as the first character of a search @@ -64,6 +70,8 @@ Definition | Example ### Phrases A phrase is a group of terms in a certain order. If you want to search for certain phrases then you can use the " operator. +Please keep in mind, that words are split when they use "CamelCase" (like mentioned in the chapter "Word Split") even when they are enclosed with `"`. + Definition | Example -----------|----------- "" - terms inside the quotes are searched for as a phrase | "Ultimate Repository" – finds `Ultimate Repository` but not `Repository Ultimate`, `Ultimate` or `Repository` diff --git a/scm-ui/ui-api/src/help/search/syntax.de.ts b/scm-ui/ui-api/src/help/search/syntax.de.ts index 6b3742296d..2f1bfb622a 100644 --- a/scm-ui/ui-api/src/help/search/syntax.de.ts +++ b/scm-ui/ui-api/src/help/search/syntax.de.ts @@ -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\`| diff --git a/scm-ui/ui-api/src/help/search/syntax.en.ts b/scm-ui/ui-api/src/help/search/syntax.en.ts index a5936d8384..a5f010a79a 100644 --- a/scm-ui/ui-api/src/help/search/syntax.en.ts +++ b/scm-ui/ui-api/src/help/search/syntax.en.ts @@ -14,7 +14,14 @@ * along with this program. If not, see https://www.gnu.org/licenses/. */ -export default `### Modifiers +export default `### Word Split + +SCM-Manager is built for code, and in code one often uses "CamelCase" words. To make it easier to search for these words, +we split them into separate words for the search. This means that searching for \`SomeManager\` will also match the term +\`SomeRepositoryManager\`. If you want to avoid this, you can simply type your words in small letters only. In the example +above, searching for \`somemanager\` will only match the term \`SomeManager\` but not \`SomeRepositoryManager\`. + +### Modifiers Note: You can not use wildcards as the first character of a search. @@ -70,6 +77,8 @@ Search supports using parentheses to group clauses to form sub queries. This can A phrase is a group of terms in a certain order. If you want to search for certain phrases then you can use the \`"\` operator. +Please keep in mind, that words are split when they use "CamelCase" (like mentioned in the chapter "Word Split") even when they are enclosed with \`"\`. + |Definition|Example| |----------|-------| |"" - terms inside the quotes are searched for as a phrase|"Ultimate Repository" – finds \`Ultimate Repository\` but not \`Repository Ultimate\`, \`Ultimate\` or \`Repository\`|