API tools faq
paste
sgc_072

Mailing List

sgc_072
Mar 29th, 2017
85
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 18.38 KB | None | 0 0
raw download clone embed print report
  1. Hi,
  2. On the IRC, I asked about the meaning of the term "Rendering transformation". I went through the Rendering Framework doc and found that 'Rendering' is just a way to convert the DOM (Data Object Model: it connects different programming languages) into a valid output which is shown to the user.
  3.  
  4. Now in the project "Glossary Application" , the idea is to present a list of definitions in the glossary app. I wanted to inquire if the definitions of the 'technical terms'(words which a user while going through the x-wiki page will find difficult to understand) of the x-wiki page is to be listed in the glossary app? And when user clicks on that word then a new page opens listing the definition of that term, feature etc?
  5.  
  6. Thanks :)
  7.  
  8.  
  9.  
  10. Hi Sarthak,
  11.  
  12. > On 18 Mar 2017, at 19:42, Sarthak Gupta <sarthakgupta072@gmail.com> wrote:
  13. >
  14. > Hi,
  15. > On the IRC, I asked about the meaning of the term "Rendering
  16. > transformation”.
  17.  
  18. Yep I saw your question and answered on IRC but you were probably not connected anymore:
  19.  
  20. "
  21. 11:42
  22. sgc072: you can check http://rendering.xwiki.org which explains what is XWiki's rendering
  23. you should also read http://rendering.xwiki.org/xwiki/bin/view/Main/Architecture and http://rendering.xwiki.org/xwiki/bin/view/Main/Extending
  24. "
  25.  
  26. > I went through the Rendering Framework doc and found that
  27. > 'Rendering' is just a way to convert the DOM (Data Object Model: it
  28. > connects different programming languages) into a valid output which is
  29. > shown to the user.
  30. >
  31. > Now in the project "Glossary Application" , the idea is to present a list
  32. > of definitions in the glossary app. I wanted to inquire if the definitions
  33. > of the 'technical terms'(words which a user while going through the x-wiki
  34. > page will find difficult to understand) of the x-wiki page is to be listed
  35. > in the glossary app?
  36.  
  37. Not sure why you make a distinction between “definitions” and “technical terms”. For me they’re the same but I’m probably not understanding what you mean.
  38.  
  39. > And when user clicks on that word then a new page
  40. > opens listing the definition of that term, feature etc?
  41.  
  42. Yes, that seems natural.
  43.  
  44. What you should do is make a detailed proposal on this list of how this app will behave according to you (nothing is predefined, I only listed some ideas on the glossary GSOC page). Then we/I can review it and give you an opinion. In short, you have some liberty to decide what the app should do :)
  45.  
  46. For example you’ll need to devise how the user will add glossary entries. There could be an “Add Entry” form on the glossary home page but there could also be a way to highlight words or a sentences while viewing a page and having an situ-way of adding an entry (similar to the way annotations are added). This would seem convenient to me.
  47.  
  48. Thanks for being interested in this project. I believe it’s something that XWiki users will love!
  49. -Vincent
  50.  
  51. > Thanks :)
  52.  
  53.  
  54.  
  55.  
  56. ​Hi Vincent,
  57.  
  58. I have come up with an idea that:
  59. 1. I will make an extension that will link to the Glossary Page.
  60. 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.
  61. 3. On clicking that button a dialog box will appear on the bottom right of the screen that will specify some options as follows:
  62. (i)For a user: (a) "Word name"(one word at a time. Next word could be accessed by clicking an another button)
  63. (b) Short description of the word, with a link for 'Read More'. Clicking on 'Read more' will direct the user to the glossary page.
  64. (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.
  65. (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).
  66. 4. The glossary page will simply be created with 'Create Page' provided in X-wiki I suppose. I need to think of interface :P.
  67.  
  68. Please suggest some improvement or additional information that I should specify before writing a proposal.
  69. I also need to think how my timeline in my proposal will be divided :P
  70.  
  71. Thanks :)
  72.  
  73.  
  74.  
  75. Hi Sarthak,
  76.  
  77. > On 20 Mar 2017, at 20:00, Sarthak Gupta <sarthakgupta072@gmail.com> wrote:
  78. >
  79. > ​Hi Vincent,
  80. >
  81. > I have come up with an idea that:
  82. > 1. I will make an extension that will link to the Glossary Page.
  83.  
  84. 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.
  85.  
  86. > 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.
  87.  
  88. Ok. We could also introduce a shortcut key as we have for annotations (ctrl+M).
  89.  
  90. I guess you’re referring to creating glossary entries right?
  91.  
  92. Because for viewing the the Rendering Transformation would simply create standard links IMO.
  93.  
  94. > 3. On clicking that button a dialog box will appear on the bottom right of the screen that will specify some options as follows:
  95.  
  96. I think it should appear just below the word(s) you selected.
  97.  
  98. > (i)For a user: (a) "Word name"(one word at a time. Next word could be accessed by clicking an another button)
  99. > (b) Short description of the word, with a link for 'Read More'. Clicking on 'Read more' will direct the user to the glossary page.
  100.  
  101. I think it’s enough to do display that on hover without clicking. Clicking would go to the glossary page.
  102.  
  103. > (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.
  104.  
  105. 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.
  106.  
  107. I don’t understand why only admins would see glossary terms on the page. IMO everyone should see them.
  108.  
  109. > (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).
  110. > 4. The glossary page will simply be created with 'Create Page' provided in X-wiki I suppose. I need to think of interface :P.
  111.  
  112. IMO there should be 2 ways:
  113. 1) same mechanism as for annotations
  114. 2) on the glossary app home page with a form
  115.  
  116. 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.
  117.  
  118. Thanks
  119.  
  120.  
  121.  
  122.  
  123. On Tue, Mar 21, 2017 at 4:09 PM, Vincent Massol <vincent@massol.net> wrote:
  124. Hi Sarthak,
  125.  
  126. > On 20 Mar 2017, at 20:00, Sarthak Gupta <sarthakgupta072@gmail.com> wrote:
  127. >
  128. > ​Hi Vincent,
  129. >
  130. > I have come up with an idea that:
  131. > 1. I will make an extension that will link to the Glossary Page.
  132.  
  133. ​​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.
  134.  
  135.  
  136. I was talking about the home page(I will make) of the glossary app that I proposed. :P​
  137.  
  138.  
  139. > 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.
  140.  
  141. Ok. We could also introduce a shortcut key as we have for annotations (ctrl+M).
  142.  
  143. I guess you’re referring to creating glossary entries right?
  144.  
  145. ​Yup, glossary entries will be created on clicking the 'Make entry' button by admin or by shortcut key as proposed by you.
  146. Because for viewing the the Rendering Transformation would simply create standard links IMO.
  147.  
  148.  
  149. ​I need to think how this will work.
  150. ​
  151. > 3. On clicking that button a dialog box will appear on the bottom right of the screen that will specify some options as follows:
  152.  
  153. I think it should appear just below the word(s) you selected.
  154.  
  155. ​Yes, this would be better. The dialog box will move along the screen as we move to the next word.
  156. ​
  157. > (i)For a user: (a) "Word name"(one word at a time. Next word could be accessed by clicking an another button)
  158. > (b) Short description of the word, with a link for 'Read More'. Clicking on 'Read more' will direct the user to the glossary page.
  159.  
  160. I think it’s enough to do display that on hover without clicking. Clicking would go to the glossary page.
  161. ​Yes, I agree with this too.​
  162. > (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.
  163.  
  164. 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.
  165.  
  166. I don’t understand why only admins would see glossary terms on the page. IMO everyone should see them.
  167.  
  168. ​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.​
  169.  
  170.  
  171. > (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).
  172. > 4. The glossary page will simply be created with 'Create Page' provided in X-wiki I suppose. I need to think of interface :P.
  173.  
  174. IMO there should be 2 ways:
  175. 1) same mechanism as for annotations
  176. 2) on the glossary app home page with a form
  177.  
  178. ​I am not able to grasp these points. So I would try discussing it on IRC​probably .
  179. 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.
  180.  
  181. ​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. :)
  182.  
  183. Thanks
  184.  
  185.  
  186.  
  187. Hi Vincent,
  188.  
  189. I have created a design page
  190.  
  191. Link: http://design.xwiki.org/xwiki/bin/view/Proposal/GlossaryApplication
  192.  
  193. I request you to review it and please tell me if anything needs to be added/modified in it.
  194.  
  195. Thanks :)
  196.  
  197.  
  198.  
  199.  
  200. Hi Sarthak,
  201.  
  202. > On 24 Mar 2017, at 16:44, Sarthak Gupta <sarthakgupta072@gmail.com> wrote:
  203. >
  204. > Hi Vincent,
  205. >
  206. > I have created a design page
  207. >
  208. > Link: http://design.xwiki.org/xwiki/bin/view/Proposal/GlossaryApplication
  209.  
  210. I’ve commented on the page.
  211.  
  212. Thanks
  213.  
  214.  
  215.  
  216.  
  217. Hi Vincent,
  218. 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.
  219.  
  220. The things I know are to be done are:
  221. The glossary app homepage will be created by "App within minutes application".
  222. Using rendering transformation to create links to the app and to display the words.
  223. Developing the extension whose mechanism will be analogous to that of annotation extension.
  224. Linking the extension with the glossary home page and to pages containing definition of words.
  225. Please guide me.
  226.  
  227. Thanks
  228.  
  229.  
  230.  
  231.  
  232. Hi Sarthak,
  233.  
  234. > On 26 Mar 2017, at 14:45, Sarthak Gupta <sarthakgupta072@gmail.com> wrote:
  235. >
  236. > Hi Vincent,
  237. > I am not able to decide how would my approach be like to develop the
  238. > glossary application. I have an idea what I need to do to develop this app
  239. > but couldn't able to decide the milestones(that I will write in my
  240. > proposal) I should set.
  241. >
  242. > The things I know are to be done are:
  243. >
  244. > - The glossary app homepage will be created by "App within minutes
  245. > application".
  246.  
  247. Yes it’s fine to use AWM although it’s not required at all and another UI could be proposed/done.
  248.  
  249. See http://platform.xwiki.org/xwiki/bin/view/DevGuide/FAQTutorial/FAQTutorialManual to understand how it works. You really need to understand this rather than use the AWM which hides how it works.
  250.  
  251. > - Using rendering transformation to create links to the app and to
  252. > display the words.
  253.  
  254. Yes,except not direct links but on hover information + link in the on hover popup.
  255.  
  256. > - Developing the extension whose mechanism will be analogous to that of
  257. > annotation extension.
  258.  
  259. I don’t know what you call “extension”. I think you mean the in-context creation of glossary entries.
  260.  
  261. > - Linking the extension with the glossary home page and to pages
  262. > containing definition of words.
  263.  
  264. What do you call extension? In XWiki an extension has a special meaning, see http://extensions.xwiki.org/xwiki/bin/view/Extension/
  265.  
  266. > Please guide me.
  267.  
  268. I would if I knew what you’re looking for precisely :)
  269.  
  270. You’ve already listed several steps above. Couldn’t that be your milestones?
  271.  
  272. 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):
  273. * Provide an Admin UI to configure the Glossary application. For example to configure on which pages the transformation should execute (with regex includes/excludes)
  274. * Allow using Wikipedia (or other sources) to automatically gather information about glossary items.
  275.  
  276. Thanks!
  277.  
  278.  
  279.  
  280.  
  281. Hi ​V​incent,
  282.  
  283. ​I am going through what you said and will try to think of some other features that I can include in this glossary application.
  284.  
  285. 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.
  286. 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.
  287.  
  288. 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. :/
  289.  
  290.  
  291.  
  292.  
  293.  
  294. Hi,
  295.  
  296. > On 27 Mar 2017, at 18:01, Sarthak Gupta <sarthakgupta072@gmail.com> wrote:
  297. >
  298. > Hi
  299. > ​V​
  300. > incent,
  301. >
  302. > ​I am going through what you said and will try to think of some other
  303. > features that I can include in this glossary application.
  304. >
  305. > My main query is that in my GSoC proposal I have to write about the
  306. > timeline in which i will carry out different tasks related to the project.
  307. > I am not able to get what should I include for different weeks and as a
  308. > part of my mid-term​ and end-term evaluation. I know that I have to divide
  309. > my tasks into smaller parts but not able to decide fully which parts are to
  310. > be carried out first and which are to be carried out latter.
  311. >
  312. > I don't know if this is a legitimate query or not, because it's* my*
  313. > proposal and I should be the one framing it accordingly. :/
  314.  
  315. For example I propose the following order:
  316.  
  317. Step 1: Create Glossary app with ability to create new entries.
  318. Step 2: Create Transformation to display glossary terms when a page is rendered
  319. Step 3: Add ability to create glossary items in context
  320. Step 4: Create a functional test to prove that steps 1, 2 and 3 work.
  321. Step 5: Release + Document a first version
  322. Step 6: <new idea1>
  323. Step 7: <new idea2>
  324. …
  325.  
  326. Now FYI, for an experienced xwiki dev this is roughly some ideas of timeframes:
  327. Step 1: 0.5 day
  328. Step 2: 1.5 days (including automated unit tests)
  329. Step 3: 2 days
  330. Step 4: 1 day
  331. Step 5: 0.5 day
  332.  
  333. 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 :)
  334.  
  335. Thanks
  336.  
  337.  
  338.  
  339.  
  340. Hi Vincent,
  341.  
  342. Thank You very much for your valuable advice.
  343. Now I am feeling little comfortable :D
  344. After some more research, I would be updating my design page and also will submit a draft of my proposal for a review.
  345.  
  346. Thanks Again :)
  347.  
  348.  
  349.  
  350.  
  351. Hi Vincent,
  352.  
  353. 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.
  354.  
  355. Also I am not able to think of other features which I could add in this proposal.
  356.  
  357. >>Provide an Admin UI to configure the Glossary application. For example to configure on which pages the transformation should execute
  358. >(with regex includes/excludes)
  359.  
  360. And I think that features to be added in Admin UI should be expanded but I am not able to think one.
  361.  
  362. >* Allow using Wikipedia (or other sources) to automatically gather information about glossary items.
  363.  
  364. This would be done using the concept of Web Scraping I suppose?
  365.  
  366. Thanks. :)
  367.  
  368.  
  369.  
  370.  
  371. Hi Sarthak,
  372.  
  373. > On 28 Mar 2017, at 21:25, Sarthak Gupta <sarthakgupta072@gmail.com> wrote:
  374. >
  375. > Hi Vincent,
  376. >
  377. > I have updated my design page and will submit the draft of my proposal in a
  378. > day or so. Kindly review it suggest some changes.
  379.  
  380. I”ve added annotations on the page. We’re getting there! There are still lots of smallish problems though (see comments).
  381.  
  382. > Also I am not able to think of other features which I could add in this
  383. > proposal.
  384.  
  385. I’ll think of some more but we can always add them as we progress.
  386.  
  387. > Provide an Admin UI to configure the Glossary application. For example
  388. > to configure on which pages the transformation should execute
  389. >> (with regex includes/excludes)
  390. >
  391. > And I think that features to be added in Admin UI should be expanded but I
  392. > am not able to think one.
  393. >
  394. >> * Allow using Wikipedia (or other sources) to automatically gather
  395. > information about glossary items.
  396. >
  397. > This would be done using the concept of* Web Scraping* I suppose?
  398.  
  399. It would be much better if wikipedia was providing some API for this, such as a REST API for example. Web scraping is just too fragile.
  400.  
  401. Thanks
Add Comment
Please, Sign In to add comment
Public Pastes
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!