Hi Sarthak,

> On 26 May 2017, at 16:36, Sarthak Gupta <[email protected]> wrote:
> 
> Hi everyone,
> I would be working on the proposal 'Glossary Application' in the coming
> days. The details of the proposal can be found on the Design Page
> <http://design.xwiki.org/xwiki/bin/view/Proposal/GlossaryApplication> .
> Please tell me if something is not clear. Any suggestions are welcomed. :)

Sorry for responding late, I was on holidays a good part of last week :)

> I wanted to propose a UI for both the pages ('HomePage' and 'glossary page
> for each item').
> 
>   - For the Glossary HomePage:
>   - A search bar will be employed on the top of page, which would search a
>      glossary page(from glossary space) if a user enters the matching
> words for
>      that glossary items. A search bar will be made using HTML/CSS.

IMO you should check the way it’s done by the FAQ application.

>      - The search results (suggestions) will be displayed on the same page
>      below the search bar along with the location of the glossary
>      item.(considering the fact that two glossary items with the same name may
>      exist). I saw that there is a 'Suggest Widget' for this. Hope I
> can make it
>      work :P .

I don’t think that’s the best. Check the FAQ app and how it does it.

What would make more sense to me if a UI similar to the FAQ one:
* Display all glossary entries in a LT
* Have a search form to search for entries
* Have a “Add Glossary Entry” button and text field to add a new entry

See http://extensions.xwiki.org/xwiki/bin/view/Extension/FAQ%20Application

>      - On clicking those links, the user will be directed to the matching
>      glossary page.
> 
> Is this UI ok?

See above

>   - Glossary Page of each glossary item:
>      - It will contain two fields.
>      - First field will be a 'String' which will contain the name of the
>      glossary item.

I don’t think that’s needed since the page name can be used as the glossary 
item name.

>      - Second field will be a 'text area' named "Glossary". It will
>      contain the glossary of that item that a user will enter itself on the
>      page, he is on.
> 
> Is this UI ok?

Actually, the need is exactly the same as for the FAQ app so it’ll be very 
simple to copy. At least initially since we may need to add other properties 
for glossary items.

The bug difference will come for the rendering side and the UI to navigate or 
add a glossary item when viewing an existing page.

> 
> After this I will update my design page and tell you about my next
> steps.....!

Thanks
-Vincent

> 
> Thanks :)
> 
> Sarthak Gupta
> [sarthakg]

Reply via email to