Re: [xwiki-devs] Glossary Application

On 26 Mar 2017, at 14:45, Sarthak Gupta <sarthakgupta072(a)gmail.com> wrote: Hi Vincent, I am not able to decide how would my approach be like to develop the glossary application. I have an idea what I need to do to develop this app but couldn't able to decide the milestones(that I will write in my proposal) I should set. The things I know are to be done are: - The glossary app homepage will be created by "App within minutes application".

- Using rendering transformation to create links to the app and to display the words.

- Developing the extension whose mechanism will be analogous to that of annotation extension.

- Linking the extension with the glossary home page and to pages containing definition of words.

Please guide me.

Thanks -Sarthak Gupta On Fri, Mar 24, 2017 at 10:38 PM, Vincent Massol &lt;vincent(a)massol.net&gt; wrote: > Hi Sarthak, > >> On 24 Mar 2017, at 16:44, Sarthak Gupta &lt;sarthakgupta072(a)gmail.com&gt; > wrote: >> >> Hi Vincent, >> >> I have created a design page >> >> Link: http://design.xwiki.org/xwiki/bin/view/Proposal/ > GlossaryApplication > > I’ve commented on the page. > > Thanks > -Vincent > >> >> I request you to review it and please tell me if anything needs to be >> added/modified in it. >> >> Thanks :) >> >> Sarthak Gupta >> >> On Thu, Mar 23, 2017 at 12:21 AM, Sarthak Gupta < > sarthakgupta072(a)gmail.com&gt; >> wrote: >> >>> >>> >>> On Tue, Mar 21, 2017 at 4:09 PM, Vincent Massol &lt;vincent(a)massol.net&gt; >>> wrote: >>> >>>> Hi Sarthak, >>>> >>>>> On 20 Mar 2017, at 20:00, Sarthak Gupta &lt;sarthakgupta072(a)gmail.com&gt; >>>> 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. >>>> >>>> >>> I was talking about the home page(I will make) of the glossary app that > I >>> proposed. :P​ >>> >>> >>> >>>>> 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? >>>> >>>> ​Yup, glossary entries will be created on clicking the 'Make entry' >>> button by admin or by shortcut key as proposed by you. >>> >>>> Because for viewing the the Rendering Transformation would simply > create >>>> standard links IMO. >>>> >>>> >>> ​I need to think how this will work. >>> ​ >>> >>>>> 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. >>>> >>>> ​Yes, this would be better. The dialog box will move along the screen > as >>> we move to the next word. >>> ​ >>> >>>>> (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. >>>> >>> ​Yes, I agree with this too.​ >>> >>>>> (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. >>>> >>>> ​I meant to say that the users will be able to see the words which have >>> entries on the glossary page. But for admin, he would be able to > see/select >>> the both the words that are 'in' and 'not in' the glossary page and make >>> changes to 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 >>>> >>>> ​I am not able to grasp these points. So I would try discussing it on >>> IRC​probably . >>> >>>> 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. >>>> >>>> ​I have initiated a page, and going through the tutorials​ on how to > use >>> the 'design page' and 'create application'. I will come out with > something >>> in few days. :) >>> >>> Thanks >>> >>> Sarthak Gupta >>> >>> > >