Wiki source code of Glossary Application

Last modified by Vincent Massol on 2024/02/26 17:52

Hide last authors
Sarthak Gupta 29.2 1 ==== (% style="font-family: inherit; font-size: 29px;" %)**Glossary Application**(%%) ====
Sarthak Gupta 9.2 2
Sarthak Gupta 26.1 3 = Description =
Sarthak Gupta 9.2 4
Sarthak Gupta 40.1 5 To develop a glossary application which will present a list of definitions of terms on the XWiki pages to a user at the very instant and will also allow to add new definitions and make changes to them on the very same page. This will enable a normal user to have a quick knowledge of the terms that are written on the XWiki pages.
Sarthak Gupta 26.1 6
Sarthak Gupta 48.1 7 === Introduction ===
Sarthak Gupta 10.1 8
Sarthak Gupta 48.1 9 Currently, there is no feature in XWiki which allow a user to add definitions and some notes for the words that are displayed on XWiki pages. This glossary application will make it easier for a normal user working on XWiki to add glossary/definition to the word/words for his own convenience to develop a quick understanding of the word/words given on XWiki pages. // //
Sarthak Gupta 26.1 10
Sarthak Gupta 48.1 11 //People are going to use this application to define the meaning of some very specific words/acronyms/etc that are related to their domains/business (e.g. “open source”, “wiki”, etc). //
Sarthak Gupta 11.1 12
Sarthak Gupta 20.1 13 = Goals(with description) =
14
15 The project requires mainly the creation of two main components:
16
Sarthak Gupta 40.1 17 ==== (% style="color: rgb(77, 88, 96); font-family: inherit; font-size: 20px;" %)1. Application UI(%%) ====
Sarthak Gupta 9.2 18
Sarthak Gupta 37.1 19 //The app will work on the XWiki pages. The app will function as follows~://
Sarthak Gupta 9.3 20
Sarthak Gupta 28.1 21
Sarthak Gupta 24.1 22 ====== **Seeing an already existing entry** ======
Sarthak Gupta 9.3 23
Sarthak Gupta 37.1 24 (% style="font-weight: normal;" %)**//The app will work on the XWiki pages. The app will function as follows~://**
Sarthak Gupta 26.1 25
Sarthak Gupta 40.1 26 * An already existing entry will be highlighted on a page. On hovering over that link, a popup will appear below the word/words.
Sarthak Gupta 26.1 27 * (% style="font-weight: normal;" %)**The popup will contain the name of that word with the small definition(extract/summary) of that word.**
28 * (% style="font-weight: normal;" %)**Different words can be accessed by just hovering over them i.e the word on which the mouse pointer is ’on’ will be displayed(along with small definition) in the popup below it.**
Sarthak Gupta 40.1 29 * (% style="font-weight: normal;" %)**Along with a small definition, there will also be a small link “Read More” inside the popup which will guide the user to a new page which will display the complete definition of the word/words (in case the user has added more to it).**
Sarthak Gupta 26.1 30
31 ====== ======
32
33 (((
34 **Adding a new entry**(The words which have no entry on the glossary pages)
35
Sarthak Gupta 24.1 36 * A user will select a word or a list of words.
37 * The user will click a shortcut key (just like for annotations) and a popup will appear below the words.
Sarthak Gupta 40.1 38 * The popup will contain the word/words on which the mouse pointer is on.
Sarthak Gupta 26.1 39 * This popup will allow the user to enter a new definition, modify it and then save it on the same page.
Sarthak Gupta 40.1 40 * In case a user wants to add more details to the word, an option will be specified in the popup which will take him to the glossary page.
Sarthak Gupta 24.1 41 * Internally it will create a new page in the glossary space.
Sarthak Gupta 26.1 42 )))
Sarthak Gupta 20.1 43
Sarthak Gupta 26.1 44 ==== ====
Sarthak Gupta 24.1 45
Sarthak Gupta 26.1 46 (((
Sarthak Gupta 28.1 47 (% style="color: rgb(77, 88, 96); font-family: inherit; font-size: 20px;" %)2. Glossary Pages
Sarthak Gupta 24.1 48
Sarthak Gupta 26.1 49 (((
Sarthak Gupta 48.1 50 //These are the list of pages which will have the definition of words. It will comprise of two components~://
Sarthak Gupta 10.1 51
52
Sarthak Gupta 26.1 53 **Glossary Home Page**
54
55 * (((
Sarthak Gupta 53.2 56 This page will contain the links for various definition already on the glossary page. [done]
Sarthak Gupta 26.1 57 )))
58 * (((
Sarthak Gupta 53.2 59 Different definitions can be found by simple search. [done]
Sarthak Gupta 26.1 60 )))
61 * (((
Sarthak Gupta 53.2 62 On clicking those links the user will be guided to the matching glossary page for that particular word. [done]
Sarthak Gupta 26.1 63 )))
Sarthak Gupta 31.2 64 * (((
Sarthak Gupta 53.2 65 Basic CRUD functionalities will be implemented on this page [Already there]
Sarthak Gupta 31.2 66 )))
Sarthak Gupta 26.1 67
68 **Glossary pages for each definition**
69
Sarthak Gupta 53.2 70 * The idea is to create a separate glossary page for each word (whose definition is required) in the XWiki. [done]
Sarthak Gupta 26.1 71
72
73 )))
74 )))
75
Sarthak Gupta 30.2 76 == ==
77
Sarthak Gupta 28.1 78 == Approach ==
Sarthak Gupta 26.1 79
Sarthak Gupta 52.1 80 1. Creation of Glossary Homepage.[Done]
Sarthak Gupta 30.2 81 1. (((
Sarthak Gupta 53.1 82 Creation Transformation to display glossary items when a page renders.[Done].
Sarthak Gupta 30.2 83 )))
84 1. (((
Sarthak Gupta 53.2 85 Releasing + documenting the first version [Done]
Sarthak Gupta 53.1 86 )))
87 1. (((
88 Create a feature of the popup on hovering.
89 )))
90 1. (((
Sarthak Gupta 30.2 91 Adding the ability to create glossary items in context with the page.
92 )))
93 1. (((
Sarthak Gupta 48.1 94 Create functional tests to prove that above-given steps work.
Sarthak Gupta 45.1 95 )))
96 1. (((
Sarthak Gupta 30.2 97 Adding the ideas as given below.
98 )))
Sarthak Gupta 45.1 99 1. (((
100 Releasing the final version with documentation.
101 )))
Sarthak Gupta 28.1 102
Sarthak Gupta 30.2 103 == Ideas ==
104
Sarthak Gupta 48.1 105 ~1. Allowing the user to automatically gather info from various pages of XWiki for some glossary items.
Sarthak Gupta 30.2 106
107 (((
Sarthak Gupta 44.1 108 2. I also plan to allow using Wikipedia or other sources to automatically gather info about some(depends on the user) glossary items.
Sarthak Gupta 30.2 109
110 3. I also plan to provide an Admin UI to configure the Glossary application.
111
112
113 * For example to configure on which pages the transformation should execute (with regex includes/excludes).
114 )))
115
116
Sarthak Gupta 26.1 117 ==== ====

Get Connected