Public Lab Research note


  • 2

GSoC 2017: Final Report on Wiki Discussion

by Ashan |

First of all let me give some overall details of my GSoC project as following described features are results of GSoC 2017 program.

Project Details

Project Proposal: https://publiclab.org/notes/wiki-discussion

GSoC Project Link : https://summerofcode.withgoogle.com/projects/#5979137115160576

Contributions made : for publiclab/plots2 and for publiclab/inline-markdown-editor

Repository Host : GitHub

PublicLab's GitHub Organization : publiclab

Repositories to which contributions were made : publiclab/plots2, publiclab/inline-markdown-editor

Languages and Frameworks : Ruby, Rails, HTML, CSS, jQuery, javascript

Project Planner GitHub Issue : This GitHub issue has a checklist of all my contributions during GSoC with references to all pull requests -- work plan

Inline Commenting

Under phase 3, I implemented the feature called inline-commenting for wiki pages. It is described follow:

What is this feature

In PublicLab, wiki pages are used very often to collect information, do documentations, to give instructions on projects and etc. Under my gsoc project I'm trying to make wiki pages more interactive. One step for that is to give wiki readers ability to add comments on sub-section basis. You can think of subsections as seperate paragraphs.

How to test

Once you are logged in and reading a wiki page, click the green pensil icon in the tab menu. It's the button to change the wiki page in to inline rich wiki editor.

What the inline rich wiki editor does is, it breaks the wiki into separate sections using paragraphs. Then when you move your mouse pointer below of a paragraph you will see small pencil, question and comment icons pop up as follows.

inline_button_set.png

Then when you click the comment icon, a new inline comment form will appear below of that particular paragraph. In there you can add comments related to that paragraph. Following image displays an example for that.

inline_comment_form.png

After that when you click publish button in the form, the comment will be posted and appear below of the paragraph as shown in the following image. As you can see, in the comment there will be name of the person who posted the comment and time he/she posted.

inline_comment_added.png

When inline comment button clicked again, all will be hidden from your sight as displaying inline comments for all paragraphs at once misguide the attention from wiki page original content. When you need to read/view inline comments for a perticular paragraph or want to post a comment regarding that paragraph, you can click again the inline comment button.

A simple workthrough video for the above discussed inline commenting can be found by navigating to following youtube link: https://www.youtube.com/watch?v=GjsVmNXftFk

NOTE:

THIS FEATURE IS NOT YET PUBLISHED TO LIVE SITE. THIS RESEARCH NOTE IS FOR INTRODUCING UPCOMING FEATURE.

Future Work:

I still have the inline sugggestion feature to be completed and I'm currently working on that feature in a separate branch.

And in above described inline-commenting feature, although a inline comment can be set, still there is no any button to delete an inline comment. That also has to be implemented.



software gsoc google-summer-of-code gsoc-2017 soc soc-2017

response:14788

5 Comments

gorgeous @Ashan! can't wait to try it


:-) great! can you link to your final PR?


Good work @Ashan. Can you add the link to your commits like I suggested here. Also link to any FTO issues you made ?


Thanks all :). Following are links for my commits and pull requests:

Commits regarding inline-commenting feature: https://github.com/publiclab/plots2/pull/1571

Link for my whole GSoC workflow phases: https://github.com/publiclab/plots2/issues/1438

Links for my all commits as @ananyo2012 requested:

https://github.com/publiclab/plots2/commits?author=aspriya

https://github.com/publiclab/inline-markdown-editor/commits?author=aspriya


Hi @Ashan Can you put all these link in your research note. Thanks!


You must be logged in to comment.