Re: [xwiki-devs] Glossary Application

On 28 Mar 2017, at 21:25, Sarthak Gupta <sarthakgupta072(a)gmail.com> wrote: Hi Vincent, I have updated my design page and will submit the draft of my proposal in a day or so. Kindly review it suggest some changes.

Also I am not able to think of other features which I could add in this proposal.

Provide an Admin UI to configure the Glossary application. For example to configure on which pages the transformation should execute And I think that features to be added in Admin UI should be expanded but I am not able to think one. information about glossary items. This would be done using the concept of* Web Scraping* I suppose?

Thanks. :) Sarthak Gupta On Mon, Mar 27, 2017 at 11:06 PM, Sarthak Gupta &lt;sarthakgupta072(a)gmail.com&gt; wrote: > Hi Vincent, > > Thank You very much for your valuable advice. > Now I am feeling little comfortable :D > After some more research, I would be updating my design page and also will > submit a draft of my proposal for a review. > > Thanks Again :) > > Sarthak Gupta > > On Mon, Mar 27, 2017 at 9:38 PM, Vincent Massol &lt;vincent(a)massol.net&gt; > wrote: > >> Hi, >> >>> On 27 Mar 2017, at 18:01, Sarthak Gupta &lt;sarthakgupta072(a)gmail.com&gt; >> wrote: >>> >>> Hi >>> ​V​ >>> incent, >>> >>> ​I am going through what you said and will try to think of some other >>> features that I can include in this glossary application. >>> >>> My main query is that in my GSoC proposal I have to write about the >>> timeline in which i will carry out different tasks related to the >> project. >>> I am not able to get what should I include for different weeks and as a >>> part of my mid-term​ and end-term evaluation. I know that I have to >> divide >>> my tasks into smaller parts but not able to decide fully which parts >> are to >>> be carried out first and which are to be carried out latter. >>> >>> I don't know if this is a legitimate query or not, because it's* my* >>> proposal and I should be the one framing it accordingly. :/ >> >> For example I propose the following order: >> >> Step 1: Create Glossary app with ability to create new entries. >> Step 2: Create Transformation to display glossary terms when a page is >> rendered >> Step 3: Add ability to create glossary items in context >> Step 4: Create a functional test to prove that steps 1, 2 and 3 work. >> Step 5: Release + Document a first version >> Step 6: <new idea1> >> Step 7: <new idea2> >> … >> >> Now FYI, for an experienced xwiki dev this is roughly some ideas of >> timeframes: >> Step 1: 0.5 day >> Step 2: 1.5 days (including automated unit tests) >> Step 3: 2 days >> Step 4: 1 day >> Step 5: 0.5 day >> >> This is why I was suggesting that you include other ideas since even if >> you multiply these delays to take into account the fact that you’re new to >> xwiki dev, it would still not amount to that much :) >> >> Thanks >> -Vincent >> >>> Sarthak Gupta >>> >>> >>> On 26-Mar-2017 10:57 PM, "Vincent Massol" &lt;vincent(a)massol.net&gt; wrote: >>> >>>> Hi Sarthak, >>>> >>>>> On 26 Mar 2017, at 14:45, Sarthak Gupta &lt;sarthakgupta072(a)gmail.com&gt; >>>> 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". >>>> >>>> Yes it’s fine to use AWM although it’s not required at all and another >> UI >>>> could be proposed/done. >>>> >>>> See http://platform.xwiki.org/xwiki/bin/view/DevGuide/FAQTutoria >>>> l/FAQTutorialManual to understand how it works. You really need to >>>> understand this rather than use the AWM which hides how it works. >>>> >>>>> - Using rendering transformation to create links to the app and to >>>>> display the words. >>>> >>>> Yes,except not direct links but on hover information + link in the on >>>> hover popup. >>>> >>>>> - Developing the extension whose mechanism will be analogous to that >> of >>>>> annotation extension. >>>> >>>> I don’t know what you call “extension”. I think you mean the in-context >>>> creation of glossary entries. >>>> >>>>> - Linking the extension with the glossary home page and to pages >>>>> containing definition of words. >>>> >>>> What do you call extension? In XWiki an extension has a special >> meaning, >>>> see http://extensions.xwiki.org/xwiki/bin/view/Extension/ >>>> >>>>> Please guide me. >>>> >>>> I would if I knew what you’re looking for precisely :) >>>> >>>> You’ve already listed several steps above. Couldn’t that be your >>>> milestones? >>>> >>>> IMO you should also propose other features that could be implemented >>>> depending on how fast you progress on the main features. I’ll give you >> 2 >>>> examples (I’m not saying they’re the best but you should use your own >>>> experience/ideas by thinking about how you’d use this glossary feature >> and >>>> how to make it the best possible): >>>> * Provide an Admin UI to configure the Glossary application. For >> example >>>> to configure on which pages the transformation should execute (with >> regex >>>> includes/excludes) >>>> * Allow using Wikipedia (or other sources) to automatically gather >>>> information about glossary items. >>>> >>>> Thanks! >>>> -Vincent >>>> >>>>> 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 < >> vincent(a)massol.net&gt; >>>>>>>> wrote: >>>>>>>> >>>>>>>>> Hi Sarthak, >>>>>>>>> >>>>>>>>>> On 20 Mar 2017, at 20:00, Sarthak Gupta < >> 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 >>>>>>>> >>>>>>>> >>>>>> >>>>>> >>>> >>>> >> >> >