About me
Name: K.A.A Priyadarshana
Email: ashanpriyadarshana@gmail.com
Gitter nick: aspriya
LinkedIn profile: https://www.linkedin.com/in/ashan-priyadarshana-25425282/
Affiliation: Bsc(Hons) in Information Technology, Faculty of Information Technology, University of Moratuwa.
Location: Colombo, Sri Lanka (GMT +5:30)
Phone: +94711005491
Project description
Abstract/summary (<20 words):
Making wiki pages more interactive and discussion-oriented by adding features like commenting, suggesting and tagging special parts of wiki.
Problem
Wiki pages are web pages that anyone can create or edit. We use them to collect information, documentation and instructions on projects. At present we can create wikis, edit them and associate tags with them. But we can not add comments to this, can not make suggestions, can not tag a user for a special part in the wiki. We can make wikis more alive by implementing these features. And as shown in the above diagram, implementing these as in Google docs would be more attractive. For this I will use the publiclab/inline-markdown-editor
.
Implementation
After integrating wiki pages with inline-markdown-editor
, page of a wiki will be broken down into sections. Then after that i will develop so users can view comments, view suggestion, make comments and make suggestions on those each section. Mockups for those functions are as follows.
Active Sections
When mouse is moved over sections, those will get active and will have a emboss effect to indicate that. And then links/buttons for editing, commenting/suggesting, view comments and view suggestions will be displayed below that active section. A mockup is as follows.
In this mockup second paragraph is the active paragraph (mouse pointer is above that section). And also the way of showing comments of a paragraph is also show here (i.e comments related to fourth paragraph is displayed).
Commenting
When clicked the commenting icon
, an inline form will appear below the related paragraph. A user will enter his/her comments and save. And those comments will be shown as in previous image. A mockup to show the entering of comments is as follows.
Suggestions
When clicked the pencil
icon, an inline form will appear below the related paragraph. A user will have the ability to edit that section or to make suggestions for that section using this appeared form. And all the contents of the section will automatically be present inside the form, so that the user does not have type content of section in order to edit or suggest. A mockup of that functionality is below.
Viewing suggestions
When clicked the view suggestions
button, all the suggestions will get applied to the paragraph and those suggestion parts will be displayed in red color. And all the suggestion will get a number such as [ 1 ]
. This will happen automatically so the person who make the suggestion does not have to worry about it. And then there will be options to accept, resolve, and discard those suggestion. A sample mockup is as follows.
Timeline/milestones
Needs
Additional notes or documents regarding wikis would be great. And I need guidance from Public Lab director board and from my mentor.
Setup
Yes I have forked the publiclab/plots2 repository and I have a running version in my local. And I pulled all the updates with remote repository.
And I have setup the publiclab/plots2
in an AWS EC2 instance
. I will use this to show my work to mentors. This will be a great help for me and for my mentor to discuss by looking at a live version of publiclab/plots2
with what I have implemented. Following is the IP address of the the account and to view it you can click the link.
Experience
Before I attend to university I did course on higher diploma in IT. In there I learned Java, C#, PHP and other most Basic Web Technologies. I learnt fundamental web building blocks from PHP and from codeigniter framework. At University, I moved to ruby and Rails as a web development framework. I have experience in technologies such as Ruby, Java, JavaScript, HTML, CSS, GIT and frameworks/libraries such as Java SDK, Android SDK, CodeIgniter, ASP.net, Ruby on Rails, etc. I also managed to work part time at a company called Vesess which is specialized in web application development, during the 2nd year of my undergraduate course. I mostly worked with technologies like Ruby, RoR, MySQL, GIT, JavaScript etc. In this time period I developed ApistaCRM
by using ruby on rails And now I am an Intern at Vesess and contributing to project Hiveage
by improving its test cases. Following is the link for ApistaCRM
that i have developed.
Yes I went through the contributor guidelines and I have good knowledge about Git and I am very much familiar with both GitHub and GitLab. And yes, I have almost contributed to Public Lab
Teamwork
Me as a undergraduate student, teamwork is not a strange thing. In the university for all the academic projects we work as a team. In first year we developed a tv-remote and computer controllable wall clock with another five students. And in second year we developed a mobile app which dispalys web sites attractively, human friendly and which removes advertisements.Both of these projects were one year long and were 5 member groups. So I know that there are barriers, failures and conflicts when working with a team, and also with my experience I know how to manage difficulties and how to communicate with team mates positively.
Passion
As a deep nature lover and an observer, Public Lab always interests me. I always admire the work you guys do. And I started my open source path by this. The first feeling of getting a PR accepted was gained by Public Lab. So Yes, For sure Public Lab always interests me.
Ongoing involvement:
These are my previous contribution to the project
https://github.com/publiclab/plots2/issues/1260
https://github.com/publiclab/plots2/pull/1356
https://github.com/publiclab/plots2/issues/1358
Commitment
Yes I Understood that Importance of this project and I can spend required time period to complete particular task without being time oriented. and since my mentors and me are in completely different time zones I can keep my communication with my mentor organization without any interruptions and delays.
12 Comments
This is great to hear, @Ashan -- I've been thinking about how we could use inline tags to make this possible, but it's a challenge. Some things to think about:
the bright [suggest:1234]**eyed fox was**[/suggest] looking for food
, then what happens if the text is changes a) inside the tags, b) outside and including the tags, or c) partly outside and partly inside -- like if someone changesbright eyed
todim-witted
?There are a lot of places things can go wrong, basically. And if we don't store comments inline in the text, then how do we know where to display them? (This is why I'm suggesting inline comment storage, actually.)
An inline comment might be like:
This person [comment:1234] went to the store.
while one on its own line might be like:
This person went to the store.
[comment:1234]
Then they ate food.
Sorry for my crude examples, but I hope this helps get you thinking about the complexity of this! I /also/ think that we should consider how comments appear while editing a section -- for example with the inline editor: https://github.com/publiclab/inline-markdown-editor
This last editor may also be where we prompt people to actually create comments -- next to the pencil button in the example, there might be a comment button.
This is a lot of info -- what do you think?
Is this a question? Click here to post it to the Questions page.
Reply to this comment...
Log in to comment
Wow, thanks for the feedback. hmm, as you have mentioned for commenting, a small comment button next to pencil button might do the job.
Yes, Due to the mentioned problems inline comment storage seems to be good. I am still thinking and researching about the issues with
suggestions
as you have mentioned. For a instance we could give notifications if a user is editing texts containing suggestions. But that may not be 100% solution. Have to think and research more on this.Thanks again for these info. I forked and learning about the
inline-markdown-editor
. It would be great if you can share some links or notes to understandpubliclab/inline-markdown-editor
Reply to this comment...
Log in to comment