mirror of
https://github.com/scm-manager/scm-manager.git
synced 2025-11-10 07:25:44 +01:00
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:
@@ -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 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.
|
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
|
### Modifikatoren
|
||||||
|
|
||||||
Hinweis: Sie können keine Wildcards als erstes Zeichen einer Suche verwenden.
|
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.
|
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
|
Definition | Beispiel
|
||||||
-----------|-----------
|
-----------|-----------
|
||||||
"" - Begriffe innerhalb der Anführungszeichen werden als Phrase gesucht | "Ultimate Repository" – findet `Ultimate Repository`, aber nicht `Repository Ultimate`, `Ultimate` oder `Repository`
|
"" - Begriffe innerhalb der Anführungszeichen werden als Phrase gesucht | "Ultimate Repository" – findet `Ultimate Repository`, aber nicht `Repository Ultimate`, `Ultimate` oder `Repository`
|
||||||
|
|||||||
@@ -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.
|
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.
|
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
|
### Modifiers
|
||||||
Note: You can not use wildcards as the first character of a search
|
Note: You can not use wildcards as the first character of a search
|
||||||
@@ -64,6 +70,8 @@ Definition | Example
|
|||||||
### Phrases
|
### 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.
|
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
|
Definition | Example
|
||||||
-----------|-----------
|
-----------|-----------
|
||||||
"" - terms inside the quotes are searched for as a phrase | "Ultimate Repository" – finds `Ultimate Repository` but not `Repository Ultimate`, `Ultimate` or `Repository`
|
"" - terms inside the quotes are searched for as a phrase | "Ultimate Repository" – finds `Ultimate Repository` but not `Repository Ultimate`, `Ultimate` or `Repository`
|
||||||
|
|||||||
@@ -14,7 +14,15 @@
|
|||||||
* along with this program. If not, see https://www.gnu.org/licenses/.
|
* 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.
|
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.
|
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|
|
|Definition|Beispiel|
|
||||||
|----------|--------|
|
|----------|--------|
|
||||||
|"" - Begriffe innerhalb der Anführungszeichen werden als Phrase gesucht|"Ultimate Repository" – findet \`Ultimate Repository\` aber nicht \`Repository Ultimate\`, \`Ultimate\` oder \`Repository\`|
|
|"" - Begriffe innerhalb der Anführungszeichen werden als Phrase gesucht|"Ultimate Repository" – findet \`Ultimate Repository\` aber nicht \`Repository Ultimate\`, \`Ultimate\` oder \`Repository\`|
|
||||||
|
|||||||
@@ -14,7 +14,14 @@
|
|||||||
* along with this program. If not, see https://www.gnu.org/licenses/.
|
* 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.
|
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.
|
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|
|
|Definition|Example|
|
||||||
|----------|-------|
|
|----------|-------|
|
||||||
|"" - terms inside the quotes are searched for as a phrase|"Ultimate Repository" – finds \`Ultimate Repository\` but not \`Repository Ultimate\`, \`Ultimate\` or \`Repository\`|
|
|"" - terms inside the quotes are searched for as a phrase|"Ultimate Repository" – finds \`Ultimate Repository\` but not \`Repository Ultimate\`, \`Ultimate\` or \`Repository\`|
|
||||||
|
|||||||
Reference in New Issue
Block a user