Menu ▾ ▴

#530 Allow searching for keywords in the documentation browser

v1.1.x
closed
Erik Hänel
gui (58) documentation (9)
v1.1.4
Change Request
2022-08-05
2020-06-04
Erik Hänel
No

The search field of the documentation browser may only search for article names. It would be helpful, if it will search also through the list of keywords assigned with an article.

Analysis:

Can be done by extending the TreeSearchCtrl to search within the wxTreeCtrls tree data and by creating a common base class containing the tooltip string to be searched. Furthermore, the function for getting the index from the kernel has also to return the associated keywords.

Implementation:

  • Implementation: Implemented as proposed by the analysis.
  • Revision: [r1193]
  • Implementation test: The search bar was used to search for other terms than those available in the keywords. The expected results were yielded nevertheless.

Documentation:

  • [x] ChangesLog updated
  • [x] Code changes commented
  • Documentation articles:
    • [ ] corresponding documentation articles updated
    • [ ] new documentation articles created
    • [x] not needed
  • Language files:
    • [ ] corresponding language files updated
    • [x] not needed

Tests:

Tested manually. No deviations detected.

Related

Commit: [r1193]

Discussion

  • Erik Hänel

    Erik Hänel - 2021-07-06
    • Version: Planned --> v1.1.4
     

  • Erik Hänel

    Erik Hänel - 2021-08-18
    • labels: --> gui, documentation
     

  • Erik Hänel

    Erik Hänel - 2022-07-24
    • status: open --> accepted
     

  • Erik Hänel

    Erik Hänel - 2022-07-24
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1 +1,23 @@
 The search field of the documentation browser may only search for article names. It would be helpful, if it will search also through the list of keywords assigned with an article.
+
+###Analysis:
+(*Describe, what's the issue and which changes have to be made*)
+
+###Implementation:
+* Implementation: (*Describe, what you've changed*) 
+* Revision: [rXXX]
+* Implementation test: (*Describe the type of test, which you performed, and if it was successful*)
+
+###Documentation:
+* [ ] ChangesLog updated
+* [ ] Code changes commented
+* **Documentation articles:**

+    * [ ] corresponding documentation articles updated
+    * [ ] new documentation articles created
+    * [ ] not needed
+* **Language files:**
+    * [ ] corresponding language files updated
+    * [ ] not needed
+
+###Tests:
+(*Describe, which tests you performed and their outcome*)
    • status: accepted --> analyzing
     

  • Erik Hänel

    Erik Hänel - 2022-07-24
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -1,7 +1,7 @@
 The search field of the documentation browser may only search for article names. It would be helpful, if it will search also through the list of keywords assigned with an article.

 ###Analysis:
-(*Describe, what's the issue and which changes have to be made*)
+Can be done by extending the `TreeSearchCtrl` to search within the `wxTreeCtrl`s tree data and by creating a common base class containing the tooltip string to be searched. Furthermore, the function for getting the index from the kernel has also to return the associated keywords.

 ###Implementation:

 * Implementation: (*Describe, what you've changed*)
    • status: analyzing --> implementing
     

  • Erik Hänel

    Erik Hänel - 2022-07-24
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -4,20 +4,20 @@
 Can be done by extending the `TreeSearchCtrl` to search within the `wxTreeCtrl`s tree data and by creating a common base class containing the tooltip string to be searched. Furthermore, the function for getting the index from the kernel has also to return the associated keywords.

 ###Implementation:
-* Implementation: (*Describe, what you've changed*) 
-* Revision: [rXXX]
-* Implementation test: (*Describe the type of test, which you performed, and if it was successful*)
+* Implementation: Implemented as proposed by the analysis.
+* Revision: [r1193]
+* Implementation test: The search bar was used to search for other terms than those available in the keywords. The expected results were yielded nevertheless.

 ###Documentation:
-* [ ] ChangesLog updated
-* [ ] Code changes commented
+* [x] ChangesLog updated
+* [x] Code changes commented

 * **Documentation articles:**
     * [ ] corresponding documentation articles updated
     * [ ] new documentation articles created
-    * [ ] not needed
+    * [x] not needed
 * **Language files:**
     * [ ] corresponding language files updated
-    * [ ] not needed
+    * [x] not needed

 ###Tests:
 (*Describe, which tests you performed and their outcome*)
    • status: implementing --> testing
     

    Related

    Commit: [r1193]

  • Erik Hänel

    Erik Hänel - 2022-08-05
    • Description has changed:

    Diff:

    --- old
+++ new
@@ -20,4 +20,4 @@

     * [x] not needed

 ###Tests:
-(*Describe, which tests you performed and their outcome*)
+Tested manually. No deviations detected.
    • status: testing --> closed
     

Anonymous
Anonymous

Add attachments
Cancel





MongoDB Logo MongoDB