Nemcio/SCM-Manager
1
0
Fork 0
mirror of https://github.com/scm-manager/scm-manager.git synced 2025-11-09 15:05:44 +01:00
Code Issues Packages Projects Releases Activity

Add hint for CamelCase word breaks to search documentation

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

12
scm-ui/ui-api/src/help/search/syntax.de.ts
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\`|

11
scm-ui/ui-api/src/help/search/syntax.en.ts
View File

@@ -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\`|