21 Mar
2017
21 Mar
'17
11:39 a.m.
Hi Sarthak,
On 20 Mar 2017, at 20:00, Sarthak Gupta
<sarthakgupta072(a)gmail.com> wrote:
Hi Vincent,
I have come up with an idea that:
1. I will make an extension that will link to the Glossary Page.
The extension *is* the Glossary app. There’s no glossary page in XWiki ATM. The point of
this project is to create this app/extension.
2. The idea would be whenever a user will select a
list of words in the page, then a button will appear just above the text.
Ok. We could also introduce a shortcut key as we have for annotations (ctrl+M).
I guess you’re referring to creating glossary entries right?
Because for viewing the the Rendering Transformation would simply create standard links
IMO.
3. On clicking that button a dialog box will appear on
the bottom right of the screen that will specify some options as follows:
I think it should appear just below the word(s) you selected.
(i)For a user: (a) "Word name"(one word
at a time. Next word could be accessed by clicking an another button)
(b) Short description of the word, with a link for 'Read
More'. Clicking on 'Read more' will direct the user to the
glossary page.
I think it’s enough to do display that on hover without clicking. Clicking would go to the
glossary page.
(ii) For an Admin: (a) The JavaScript will scan
each and every word of the selected text, and will display if a word in the selected
text is in the Glossary Page or not(by the use different
color for each word that is 'in' and that is 'not in'
the glossary page.
That’s one way of doing it indeed. Another way (possibly better or not - We need to list
the pros and cons of each approach) is to use a Rendering Transformation since it’s meant
for that.
I don’t understand why only admins would see glossary terms on the page. IMO everyone
should see them.
(b) Add the word to
the glossary page/ Make changes(which will direct the admin to the glossary page and there
he could add new entries or make changes to the
original one).
4. The glossary page will simply be created with 'Create Page' provided in X-wiki
I suppose. I need to think of interface :P.
IMO there should be 2 ways:
1) same mechanism as for annotations
2) on the glossary app home page with a form
It would be nice if you could create a design page on design.xwiki.org so that we can
record all decisions that we take.
Thanks
-Vincent
Please suggest some improvement or additional
information that I should specify before writing a proposal.
I also need to think how my timeline in my proposal will be divided :P
Thanks :)
Sarthak Gupta