GSoC 2009 Complete ODT Import/Export by atmb4u: Difference between revisions

From Scribus Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
'''ABSTRACT
'''ABSTRACT
'''
'''
This project aims Implementing complete ODT/SXW files import and export (i.e. enable the import of ODT files as files, not just as formatted text). This is achieved by using a plug-in to import ODT files, stand alone from the Scribus' stub.
This project aims at implementing complete ODT/SXW files import and export (i.e. enable the import of ODT files as files, not just as formatted text). This is achieved by using a plug-in to import ODT file.


    
    
Line 7: Line 7:
'''MOTIVATION'''
'''MOTIVATION'''


ODT is a univeral open source format which is very popular making essential to be imported into the Scribus. Scribus makes desktop publishing with free and open software possible and, I found it necessary to import ODT files as it is into the workspace, for making it work better. I found first phase of this project has been executed last GSoC, i.e. GSoC 2008, which motivates me to complete that ODT importing part. 
ODT is a univeral open source format which is very popular making essential to be imported into the Scribus. Scribus makes desktop publishing with free and open software possible and, I found it necessary to import ODT files as it is into the workspace, for making it work better.


   
   
Line 13: Line 13:
'''OBJECTIVES'''
'''OBJECTIVES'''


Complete ODT import and export plug-in for Scribus
Complete ODT/SXW import and, if time permits, export for Scribus via plug-ins.


Document the plug-in correctly and neatly.
Document the plug-ins correctly and neatly.


   
   
Line 22: Line 22:
The major challenges that will be faced during the implementation of this project are
The major challenges that will be faced during the implementation of this project are


-Reading out ODT files
*Reading ODT files.
 
*Extracting graphics, tables and formulas and if necessary convert them to a format that can be used by Scribus (e.g. SVG).
-Open an ODT in the workspace by converting it to a master document
*Open an ODT in the workspace by converting it to a Scribus document
 
More discussion with the community is needed to decide upon the above said challenges




Line 35: Line 33:
[[Phase I – Gather it up]]
[[Phase I – Gather it up]]


April 28-May 08 – Understand the XML formatting of ODT files. Read out the documentation of Scribus completely especially more about how to program Scribus. Communicate with mentors and clear basic doubts about the project.
April 28-May 08 – Understand the XML formatting of ODT files. Read the documentation of Scribus completely, especially more about how to program Scribus. Communicate with mentors and clear basic doubts about the project.


[[Phase II –Rip him off]]
[[Phase II –Rip him off]]


May 08-May 17 –Design the structure of the plug-in and discuss in the irc about the structure.
May 08-May 17 –Design the structure of the plug-in and discuss its structure on IRC.


[[Phase III – Code him out]]
[[Phase III – Code him out]]
Line 53: Line 51:
[[Phase IV – Pack Up]]
[[Phase IV – Pack Up]]


August 1-August 17 – Complete the documentation and completely comment up the code(Clean Coding).
August 1-August 17 – Complete the documentation and completely comment up the code (Clean Coding).




Note: Timeline doesn't include interaction with the mentor every day.
Note: Timeline doesn't include interaction with the mentor every day.
Line 63: Line 60:
'''PROJECT OUTCOMES'''
'''PROJECT OUTCOMES'''


The expected outcomes of this project are as follows
The expected outcomes of this project are as follows:


-The ODT files can be imported as files itself using a plug-in not as texts as at present.
*ODT/SXW files can be imported as files using a plug-in not just as texts as at present.
*Proper documentation of the functionality and the code.


-Clean Documentation for the above plug-in.
-Clean Documentation for the above plug-in.
Line 85: Line 83:
I am Anoop Thomas Mathew, and am currently studying for B. Tech degree in Computer Science and Engineering, at College of Engineering, Chengannur, Kerala, INDIA.  
I am Anoop Thomas Mathew, and am currently studying for B. Tech degree in Computer Science and Engineering, at College of Engineering, Chengannur, Kerala, INDIA.  


I have been using Gnu/Linux for the past 5 years, starting off with RHEL 4 through ubuntu.
I have been using GNU/Linux for the past 5 years, starting off with RHEL 4 through Ubuntu.


I have good knowledge in C,C++, java and Python, and I've been into coding them for past 5 years.  
I have good knowledge in C, C++, Java and Python, and I've been into coding in them for the past 5 years.  


I am a member of FSF for last 3 years and had been fixing a few bugs in Vim text editor. I am in the Vim development mailing list for more than one year. I scribus, I don’t have any previous experience, but I expect to work with scribus through GSoC 2009.
I am a member of FSF since 3 years and had been fixing a few bugs in the Vim text editor. I am in the Vim development mailing list for more than one year. I don’t have any previous experience with Scribus, but I hope to work with Scribus through GSoC 2009.

Revision as of 21:47, 28 March 2009

ABSTRACT This project aims at implementing complete ODT/SXW files import and export (i.e. enable the import of ODT files as files, not just as formatted text). This is achieved by using a plug-in to import ODT file.


MOTIVATION

ODT is a univeral open source format which is very popular making essential to be imported into the Scribus. Scribus makes desktop publishing with free and open software possible and, I found it necessary to import ODT files as it is into the workspace, for making it work better.


OBJECTIVES

Complete ODT/SXW import and, if time permits, export for Scribus via plug-ins.

Document the plug-ins correctly and neatly.


CHALLENGES

The major challenges that will be faced during the implementation of this project are

  • Reading ODT files.
  • Extracting graphics, tables and formulas and if necessary convert them to a format that can be used by Scribus (e.g. SVG).
  • Open an ODT in the workspace by converting it to a Scribus document


TIME LINE

Following is the detailed road map of implementing the project.

Phase I – Gather it up

April 28-May 08 – Understand the XML formatting of ODT files. Read the documentation of Scribus completely, especially more about how to program Scribus. Communicate with mentors and clear basic doubts about the project.

Phase II –Rip him off

May 08-May 17 –Design the structure of the plug-in and discuss its structure on IRC.

Phase III – Code him out

May 18- May 27 –Open the ODT files independent from the Scribus+ Add ODT file import option in Scribus

May 28 – Testing

May 29- June 27 –Link both plug-in and Scribus and debug

June 28- August 1 – Complete the coding and sync the entire project.

Phase IV – Pack Up

August 1-August 17 – Complete the documentation and completely comment up the code (Clean Coding).


Note: Timeline doesn't include interaction with the mentor every day.


PROJECT OUTCOMES

The expected outcomes of this project are as follows:

  • ODT/SXW files can be imported as files using a plug-in not just as texts as at present.
  • Proper documentation of the functionality and the code.

-Clean Documentation for the above plug-in.

ABOUT ME

Name: Anoop Thomas Mathew

IRC Nick: atmb4u

Email ID: atmb4u@gmail.com

Location: Kerala, India

Timezone : GMT + 5:30


I am Anoop Thomas Mathew, and am currently studying for B. Tech degree in Computer Science and Engineering, at College of Engineering, Chengannur, Kerala, INDIA.

I have been using GNU/Linux for the past 5 years, starting off with RHEL 4 through Ubuntu.

I have good knowledge in C, C++, Java and Python, and I've been into coding in them for the past 5 years.

I am a member of FSF since 3 years and had been fixing a few bugs in the Vim text editor. I am in the Vim development mailing list for more than one year. I don’t have any previous experience with Scribus, but I hope to work with Scribus through GSoC 2009.