SoK/2011/Calligra/Words/ReferencesTool: Difference between revisions

From KDE Community Wiki
< SoK
No edit summary
(add Mentoring category)
 
(33 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category:Mentoring]]
== Introduction ==
== Introduction ==


Calligra Words has two participants this year in Season of KDE who will work on providing a references tool.It will provide the ui for creating table of contents, citations/bibliography and end notes.
Calligra Words has two participants, undertaking project providing a reference tool, in Season of KDE 2011.This reference tool will provide the ui for citations/bibliography, footnotes and endnotes.


== Participants ==
== Participants ==
Brijesh Patel and Smit Patel are the students who are participating under the mentorship of Pierre Ducroquet. Communication and information regarding this project is done on this wiki page,on http://kodewords.wordpress.com and #calligra on freenode.org
Brijesh Patel and Smit Patel are the students who are participating under the mentorship of Pierre Ducroquet. Communication and information regarding this project is done on this wiki page and #calligra on freenode.org


== Tentative Timeline ==
== Tentative Timeline ==


== Timeline ==
a work of 2-3 days is left
 
== Current Status ==
 
1. Fixing the bug cited in the Results
 
== Results ==
 
===16/06/2011===
 
1. Foot Notes can be inserted and loaded now.


Here is my tentative timeline for the project :
2. Bug fixed : "All note are displayed except the first one."


'''May 25 to June 3 : ~1.5 weeks'''
3. Auto numbering feature added.
      Bug : numbering starts from 1 in every session.
4. Foot notes can be saved now.
      Bug : "Footnotes are saved in two different frames, one in the specific foot
            notes frame in the document and one in the normal text form, in the
            document"


Gather all the relevant information required to begin with the project in the right direction.
===19/06/2011===
Divide the work among the three of us.
 
Get familiar with the source code of strigi.
1. Fixed the bug in autonumbering feature
 
'''June 4 to June 24 : 3 weeks'''
2. Implemented renumbering feature in the footnotes
 
Formulate bases of metadata extraction from various filetypes. Implement the same in code.
3. Bugs still to be fixed
      1. "Footnotes are saved in two different frames, one in the 
'''June 25 to July 15 : 3 weeks'''
          specific foot notes frame in the document and one in the
          normal text form, in the document"
Compare own implementation with the current implementations of strigi.  
      2. "Footnotes Frame not displayed from 2nd page onwards."
Improve if need be.  
 
Add to strigi.
 
===24/06/2011===
'''July 16 to August 5 : 3 weeks'''
 
1. Added UI for inserting new citation. Citations can be inserted and saved.
Exchange respective patches of code and test rigorously.  
 
Give constructive suggestions for improvement.
2. Bugs to be fixed
      1. "Citations are always inserted at document's starting position."
'''August 6 to August 19 : 2 weeks'''
      2. "2 characters overlap in citations' tags."
 
Combine the independent works and write a cumulative patch.
===15/08/2011===
 
'''August 20 to August 31 : ~1.5 weeks'''
1. Added implementation for configuring the notes
Testing and debugging.
'''post August 31'''
The work should be over by now and this period would be used for minor tweaking (if need be).


2. Added implementation for citations and bibliography.


Any comments or suggestions (or edits?) are welcome...
3. Bugs
      1. "Footnotes Frame not displayed from 2nd page onwards."
      2. "Bibliography not displayed in the document,however,it is displayed on the terminal,so a bit       
          layout problem is there"


[-Rovin Bhandari]
== Screenshots ==


== Results ==
1. A screenshot of notes configuration dialog open for configuration of notes and in the background of 
    the dialog,it also shows some footnotes and endnotes added in the document with desired number format.[[File:screenshot_notes1.png|830px]]


[TODO by students]
2. A screenshot of citations and a dialog to insert citations.[[File:Citations screenshot.jpeg|830px]]


== External information and blogs ==


As a first step towards beginning with the project, I have prepared a formal checkpoints cum todos mindmap : [[Media:checkpoints_todos.png]], which is going to be populated in due course of time by us, the students, under the guidance of our mentor, Jos van den Oever.
3. A screenshot of bibliography loaded in the document and a output generated at debug. (it's a bug !!)[[File:Bib snapshot.jpeg|830px]]
Please contribute to populating the file; it will help us measure our progress.


[-Rovin Bhandari]
4. A screenshot of insert custom bibliography dialog. [[File:Log0.png|600px]]


== Blogs ==


[1] https://lists.sourceforge.net/lists/listinfo/strigi-devel
#http://erionism.blogspot.com
#http://smitr.blogspot.com

Latest revision as of 11:03, 20 March 2013


Introduction

Calligra Words has two participants, undertaking project providing a reference tool, in Season of KDE 2011.This reference tool will provide the ui for citations/bibliography, footnotes and endnotes.

Participants

Brijesh Patel and Smit Patel are the students who are participating under the mentorship of Pierre Ducroquet. Communication and information regarding this project is done on this wiki page and #calligra on freenode.org

Tentative Timeline

a work of 2-3 days is left

Current Status

1. Fixing the bug cited in the Results

Results

16/06/2011

1. Foot Notes can be inserted and loaded now.

2. Bug fixed : "All note are displayed except the first one."

3. Auto numbering feature added. 

     Bug : numbering starts from 1 in every session.

4. Foot notes can be saved now. 

     Bug : "Footnotes are saved in two different frames, one in the specific foot
            notes frame in the document and one in the normal text form, in the 
            document"

19/06/2011

1. Fixed the bug in autonumbering feature

2. Implemented renumbering feature in the footnotes

3. Bugs still to be fixed 

     1. "Footnotes are saved in two different frames, one in the  
         specific foot notes frame in the document and one in the 
         normal text form, in the document"
     2. "Footnotes Frame not displayed from 2nd page onwards."


24/06/2011

1. Added UI for inserting new citation. Citations can be inserted and saved.

2. Bugs to be fixed 

     1. "Citations are always inserted at document's starting position."
     2. "2 characters overlap in citations' tags."

15/08/2011

1. Added implementation for configuring the notes

2. Added implementation for citations and bibliography.

3. Bugs 

     1. "Footnotes Frame not displayed from 2nd page onwards."
     2. "Bibliography not displayed in the document,however,it is displayed on the terminal,so a bit         
         layout problem is there"

Screenshots

1. A screenshot of notes configuration dialog open for configuration of notes and in the background of   
   the dialog,it also shows some footnotes and endnotes added in the document with desired number format.



2. A screenshot of citations and a dialog to insert citations.



3. A screenshot of bibliography loaded in the document and a output generated at debug. (it's a bug !!)

4. A screenshot of insert custom bibliography dialog.

Blogs

  1. http://erionism.blogspot.com
  2. http://smitr.blogspot.com
Retrieved from "https://community.kde.org/index.php?title=SoK/2011/Calligra/Words/ReferencesTool&oldid=30821"