Know about red pen integration

classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Know about red pen integration

NILESH GULIA
Hello
I want to know more about working of red pen and its designing issues.
Skills:html5,css3,js

On Mar 26, 2017 10:57 PM, <[hidden email]> wrote:

Send devs mailing list submissions to
        [hidden email]

To subscribe or unsubscribe via the World Wide Web, visit
        http://lists.xwiki.org/mailman/listinfo/devs
or, via email, send a message with subject or body 'help' to
        [hidden email]

You can reach the person managing the list at
        [hidden email]

When replying, please edit your Subject line so it is more specific
than "Re: Contents of devs digest..."


Today's Topics:

   1. know about projects (NILESH GULIA)
   2. Re: Glossary Application (Sarthak Gupta)
   3. Re: [GSOC-2017] DokuWiki importer (Abilashini Thiyagarajah)
   4. Re: Glossary Application (Vincent Massol)


----------------------------------------------------------------------

Message: 1
Date: Sun, 26 Mar 2017 17:48:33 +0530
From: NILESH GULIA <[hidden email]>
To: [hidden email]
Subject: [xwiki-devs] know about projects
Message-ID:
        <[hidden email]>
Content-Type: text/plain; charset=UTF-8

hi there,
I am Nilesh a student in comp,science and eng.. Tell me more about red pen
integration and search callibrator and how to contribute to them.Is the
knowledge of following skills sufficient?
skills:html5,css3,javascript


------------------------------

Message: 2
Date: Sun, 26 Mar 2017 18:15:07 +0530
From: Sarthak Gupta <[hidden email]>
To: XWiki Developers <[hidden email]>
Subject: Re: [xwiki-devs] Glossary Application
Message-ID:
        <[hidden email]>
Content-Type: text/plain; charset=UTF-8

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 <[hidden email]> wrote:

> Hi Sarthak,
>
> > On 24 Mar 2017, at 16:44, Sarthak Gupta <[hidden email]>
> 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 <
> [hidden email]>
> > wrote:
> >
> >>
> >>
> >> On Tue, Mar 21, 2017 at 4:09 PM, Vincent Massol <[hidden email]>
> >> wrote:
> >>
> >>> Hi Sarthak,
> >>>
> >>>> On 20 Mar 2017, at 20:00, Sarthak Gupta <[hidden email]>
> >>> 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
> >>
> >>
>
>


------------------------------

Message: 3
Date: Sun, 26 Mar 2017 21:32:06 +0530
From: Abilashini Thiyagarajah <[hidden email]>
To: Thomas Mortagne <[hidden email]>
Cc: XWiki Developers <[hidden email]>
Subject: Re: [xwiki-devs] [GSOC-2017] DokuWiki importer
Message-ID:
        <CAFX9s621LaqY9==aVEAwiE_mb0frDXSShRPnA=[hidden email]>
Content-Type: text/plain; charset=UTF-8

Hi ,

I am working to understand the process in the implementation of
MediaWiki-XML. Mean while I am preparing the proposal. The high level
concept behind this project will be as implementing a filter which
intercepts the DokuWiki input and converts into the events to be accepted
by the output filter (correct me if I am wrong). So now I have the question
on what are the events to be supported by the filter. I found this file [1]
saying as the events related to extensions. Is these are the events to be
considered? But this file does not state any explanation on each events. I
don't understand what are these stand for. Can I have any available
references which states about events?

[1]
https://github.com/xwiki/xwiki-commons/blob/master/xwiki-commons-core/xwiki-
commons-filter/xwiki-commons-filter-events/xwiki-commons-
filter-event-extension/src/main/java/org/xwiki/filter/event/extension/
ExtensionFilter.java


Thanks and Regards,
Abilashini

*Thiyagarajah Abilashini*
Student
Department of Computer Science and Engineering
University of Moratuwa, Sri Lanka

On 23 March 2017 at 16:30, Thomas Mortagne <[hidden email]>
wrote:

> Actually I just renamed the wrongly named (was not following contrib
> rules) class to
> org.xwiki.contrib.mediawiki.xml.internal.input.
> MediaWikiInputFilterStreamFact.
>
> On Thu, Mar 23, 2017 at 11:52 AM, Thomas Mortagne
> <[hidden email]> wrote:
> > Did you look at
> > http://extensions.xwiki.org/xwiki/bin/view/Extension/
> MediaWiki/MediaWiki+XML/.
> > ? Because the Dokuwiki version will have the exact same structure than
> > this one.
> >
> > You should try to build https://github.com/xwiki-contrib/mediawiki/
> > and look at the code of
> > https://github.com/xwiki-contrib/mediawiki/tree/master/mediawiki-xml.
> > The main entry point is the class
> > org.xwiki.filter.mediawiki.xml.internal.input.
> MediaWikiInputFilterStreamFactory.
> > You can also find unit tests in this project that you can execute to
> > debug how things are working.
> >
> > On Thu, Mar 23, 2017 at 11:41 AM, Abilashini Thiyagarajah
> > <[hidden email]> wrote:
> >> Hi Thomas,
> >>
> >> I went through most of the online documents to understand the
> >> functionalities of xwiki. But a little bit confused on how to get
stated

> >> with xwiki. It would be really helpful if I get some assistance to find
> out
> >> the code base and the instructions to start with xwiki related to the
> >> project.
> >>
> >> Thanks in advance,
> >> Abilashini
> >>
> >> Thiyagarajah Abilashini
> >> Student
> >> Department of Computer Science and Engineering
> >> University of Moratuwa, Sri Lanka
> >>
> >> On 22 March 2017 at 20:10, Abilashini Thiyagarajah
> >> <[hidden email]> wrote:
> >>>
> >>> Hi Thomas,
> >>>
> >>> Thank you for the quick reply and the reference. I will continue my
> work
> >>> to get familiarized with the project and let you know my progress.
> >>>
> >>> Best Regards,
> >>> Abilashini
> >>>
> >>> Thiyagarajah Abilashini
> >>> Student
> >>> Department of Computer Science and Engineering
> >>> University of Moratuwa, Sri Lanka
> >>>
> >>> On 22 March 2017 at 19:59, Thomas Mortagne <[hidden email]>
> >>> wrote:
> >>>>
> >>>> Hi Abilashini,
> >>>>
> >>>> Welcome in the XWiki community !
> >>>>
> >>>> In case you did not do it already you might want to take a look at
> >>>> http://dev.xwiki.org/xwiki/bin/view/GoogleSummerOfCode/Guidelines.
> >>>>
> >>>> For this project the goal is to write an "Input Filter" which support
> >>>> Dokuwiki export format (whatever it is). The closed example you could
> >>>> find for this is the MediaWiki Input Filter you can find on
> >>>>
> >>>> http://extensions.xwiki.org/xwiki/bin/view/Extension/
> MediaWiki/MediaWiki+XML/.
> >>>>
> >>>> The general idea is that the extension should parse the Dokuwiki
> >>>> file/package and generate standard "events" which are sent to the
> >>>> Output Filter which turns those events into another format/storage
> >>>> (like a XARfile , an XWiki database, etc.).
> >>>>
> >>>> On Wed, Mar 22, 2017 at 2:49 PM, Abilashini Thiyagarajah
> >>>> <[hidden email]> wrote:
> >>>> > Hi,
> >>>> >
> >>>> > I am Abilashini Thiyagarajah, a final year undergraduate of
> Department
> >>>> > of
> >>>> > Computer Science and Engineering, University of Moratuwa, Sri
> Lanka. I
> >>>> > am
> >>>> > interested to contribute to the project 'DokuWiki importer'.
> Currently
> >>>> > I am
> >>>> > working on to understand the provided resources in the project
> >>>> > description.
> >>>> > I will be so glad if I get some assistance to understand the
> >>>> > requirements
> >>>> > of this project.
> >>>> >
> >>>> > Thank you,
> >>>> > Abilashini
> >>>> >
> >>>> > *Thiyagarajah Abilashini*
> >>>> > Student
> >>>> > Department of Computer Science and Engineering
> >>>> > University of Moratuwa, Sri Lanka
> >>>>
> >>>>
> >>>>
> >>>> --
> >>>> Thomas Mortagne
> >>>
> >>>
> >>
> >
> >
> >
> > --
> > Thomas Mortagne
>
>
>
> --
> Thomas Mortagne
>


------------------------------

Message: 4
Date: Sun, 26 Mar 2017 19:27:21 +0200
From: Vincent Massol <[hidden email]>
To: XWiki Developers <[hidden email]>
Subject: Re: [xwiki-devs] Glossary Application
Message-ID: <[hidden email]>
Content-Type: text/plain; charset=utf-8

Hi Sarthak,

> On 26 Mar 2017, at 14:45, Sarthak Gupta <[hidden email]> 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/
FAQTutorial/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 <[hidden email]>
wrote:

>
>> Hi Sarthak,
>>
>>> On 24 Mar 2017, at 16:44, Sarthak Gupta <[hidden email]>
>> 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 <
>> [hidden email]>
>>> wrote:
>>>
>>>>
>>>>
>>>> On Tue, Mar 21, 2017 at 4:09 PM, Vincent Massol <[hidden email]>
>>>> wrote:
>>>>
>>>>> Hi Sarthak,
>>>>>
>>>>>> On 20 Mar 2017, at 20:00, Sarthak Gupta <[hidden email]>
>>>>> 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
>>>>
>>>>
>>
>>



------------------------------

Subject: Digest Footer

_______________________________________________
devs mailing list
[hidden email]
http://lists.xwiki.org/mailman/listinfo/devs


------------------------------

End of devs Digest, Vol 117, Issue 33
*************************************
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: Know about red pen integration

vmassol
Administrator
Hi Nilesh,

> On 26 Mar 2017, at 22:14, NILESH GULIA <[hidden email]> wrote:
>
> Hello
> I want to know more about working of red pen and its designing issues.
> Skills:html5,css3,js

Cool that you’re interested in Redpen and XWiki. However you need to do your homework and read the web site of redpen and understanding a bit xwiki too. We’re not going to do the proposal on your behalf :)

You can find some ideas at http://dev.xwiki.org/xwiki/bin/view/GoogleSummerOfCode/RedPenIntegration2017

If you have specific ideas, we’ll be glad to answer.

Thanks
-Vincent

PS: Please don’t reply to digest emails and instead send new threads when you bring a new topic to the list. Thx!

[snip]

Loading...