My GSoc2011: Hyphenation to Abiword

6. How to Support more languages

2011-08-21T05:13:00.003-07:00

6. How to Support more languages

As mentioned before, we use Enchant to support more languages. So we have five backend to support more language. Take ISpell and mySpell for example.

In the folder “abiword\msvc2008\Debug\” there are the folder for hyphenation: Spell and mySpell. And there is two folder for their dictionary

User interface to manage hyphenation

2011-08-21T05:13:00.001-07:00

User interface to manage hyphenation

Doing now, user can enable or disable hyphenation function in user interface (GUI).

Ø I have finished GUI in Windows, Linux, and Cocoa.

Ø Most languages have been translated for the globalization.

Take Windows GUI for example, user can check the checkbox for enable or disable hyphenation function.

Linux and Cocoa need more tests.

4 Code Re-factor and debug

2011-08-21T05:12:00.005-07:00

4 Code Re-factor and debug

I have finish the code re-factor both in Enchant and Abiword. Code Re-factor works:

1 deal with some ugly code

2 deal with the exception

3 Simple Implementation of Chinese Spell-Check in Enchant

2011-08-21T05:12:00.003-07:00

3 Simple Implementation of Chinese Spell-Check in Enchant

After GSoc2011, I would like to add Chinese Spell-Check in Enchant. Chinese Spell-Check is also a very important issue in Word-Processor. I found some lib to support; I just build a simple framework since time is limit.

The main function:

2 Call the Hyphenation function in Abiword.

2011-08-21T05:12:00.001-07:00

2 Call the Hyphenation function in Abiword.

Ø Split run to split word and keep the format

Ø Find split info

Ø Deal with user's operation(select, delete, cut, paste)

Main Goal: call hyphenation module of enchant to display the hyphenation result in abiword. After user's operation, refresh the hyphenation-result accordingly include user adding new word, delete word, copy word, cut word

The main code is adding in the format function in LineBreaker.h(cpp)

// find the split point

while (pRunToBump && pLine->getNumRunsInLine() && (pLine->getLastRun() != m_pLastRunToKeep))

{

UT_ASSERT(pRunToBump->getLine() == pLine);

if(!pLine->removeRun(pRunToBump))

{

pRunToBump->setLine(NULL);

}

UT_ASSERT(pLine->getLastRun()->getType() != FPRUN_ENDOFPARAGRAPH);

if(pLine->getLastRun()->getType() == FPRUN_ENDOFPARAGRAPH)

{

fp_Run * pNuke = pLine->getLastRun();

pLine->removeRun(pNuke);

}

pRunToBump->printText(); //trace out debug message & run two time

pNextLine->insertRun(pRunToBump); //called when create new line

// to get the split word

if (!(pRunToBump->getPrevRun() && pLine->getNumRunsInLine() && (pLine->getLastRun() != m_pLastRunToKeep)))

{

pRunToSplit=pRunToBump;

PD_StruxIterator text(pRunToBump->getBlock()->getStruxDocHandle(),

pRunToBump->getBlockOffset() + fl_BLOCK_STRUX_OFFSET);

text.setUpperLimit(text.getPosition() + pRunToBump->getLength() - 1);

UT_ASSERT_HARMLESS( text.getStatus() == UTIter_OK );

UT_UTF8String sTmp;

while(text.getStatus() == UTIter_OK)

{

UT_UCS4Char c = text.getChar();

UT_DEBUGMSG(("| %d |",c));

if(c >= ' ' && c <128)

sTmp += static_cast<char>(c);

++text;

}

UT_DEBUGMSG(("The Split Text |%s| \n",sTmp.utf8_str()));

if(sTmp.utf8_str()!=0)

{

pWordToSplit=sTmp;

UT_DEBUGMSG(("wordToSplit |%s| \n",pWordToSplit.utf8_str()));

}

pRunToBump = pRunToBump->getPrevRun();

UT_DEBUGMSG(("Next runToBump %x \n",pRunToBump));

}

//modify src/text/fmt/xp/fb_LineBreaker.cpp to place hypernation points

//spit the word

if(pWordToSplit.length()!=NULL)

{

pWordHyphenationResult=pBlock->_hyphenateWord(pWordToSplit.ucs4_str().ucs4_str(),0,0);

int tickLeft=pLine->getAvailableWidth();

if (pWordHyphenationResult && *pWordHyphenationResult){

gchar *c = g_ucs4_to_utf8(pWordHyphenationResult, -1, NULL, NULL, NULL);

for(int index=g_utf8_strlen(c,NULL);index>=0;--index)

{

if(pWordHyphenationResult[index]=='-'&&index<tickLeft)

{

pBreakPoint=index;

fp_TextRun* textout=static_cast<fp_TextRun*>(pRunToSplit);

textout->split(pBreakPoint);

}

1.8 Test in Linux

2011-08-21T05:11:00.003-07:00

I have test the Enchant module in RedHat. It works fine for me.

1.7 Deploy of enchant in Abiword

2011-08-21T05:11:00.001-07:00

I just copy the buliding result of enchant to the right place in Abiword:

enchant\bin\Debug\libenchant_myspell.dll ---->abiword\msvc2008\Debug\lib\enchant\libenchant_myspell.dll

enchant\bin\Debug\libenchant_ispell.dll ---->abiword\msvc2008\Debug\lib\enchant\libenchant_ispell.dll

enchant\bin\Debug\libenchant.dll---->

abiword\msvc2008\Debug\bin\ibenchant.dll

1.2 Add five backends to support hyphenation

2011-08-21T05:10:00.002-07:00

including ispell, myspell, zemberek, voikko, uspell

Ø Hunspell: using seperated dictionary: such as hyph_en_us.dic. we can download dic from internet

Ø Libhyphenaiton: the dictionary is provided by author, sometimes limited

Ø Zemberek: for Turkis

Ø Voikko: for Finnish

the changes:

1 deleted the unneed connection, such as HSpell

2 add hunspell(myspell) hyphenation code

3 implement hyphenation using hunspell

4 implement hyphenation using Zemberek

======1 deleted the unneed connection, such as HSpell===========

Hebrew don’t need any hyphenation

Yiddish don’t need any hyphenation

=======2 Implement hyphenation using hunspell

In order to use libhyphenation. We need to add files:

hyphen/hnjalloc.h

hyphen/hnjalloc.c

hyphen/hyph_en_US.dic

hyphen/hyphen.c

hyphen/hyphen.gyp

hyphen/hyphen.h

hyphen/hyphen.patch

hyphen/hyphen.tex

========3 Implement hyphenation using Zemberek

just using dbus_g_proxy_call the same as Spell-Check in Zemberek:

the hyphenation is as following

char* Zemberek::hyphenate(const char* word)

{

char* result;

GError *Error = NULL;

if (!dbus_g_proxy_call (proxy, "hecele", &Error,

G_TYPE_STRING,word,G_TYPE_INVALID,

G_TYPE_STRV, &result,G_TYPE_INVALID)) {

g_error_free (Error);

return NULL;

}

char*result=0;

return result;

}

1.3 ISpell

I used Libhyphenation in ISpell. The simple code is just like this:

static char *

ispell_dict_hyphenate (EnchantDict * me, const char *const word)

{

ISpellChecker * checker;

checker = (ISpellChecker *) me->user_data;

if(me->tag!="")

return checker->hyphenate (word,me->tag);

return checker->hyphenate (word,"en_us");

}

The concrete code in ISpellChecker is :

char *

ISpellChecker::hyphenate(const char * const utf8Word, const char *const tag)

{ //we must choose the right language tag

char* param_value = enchant_broker_get_param (m_broker, "enchant.ispell.hyphenation.dictionary.path");

if(languageMap[tag]!="")

{

string result=Hyphenator(RFC_3066::Language(languageMap[tag]),param_value).hyphenate(utf8Word).c_str();

char* temp=new char[result.length()];

strcpy(temp,result.c_str());

return temp;

}

return NULL;

}

1.4 MySpell

I used Libhyphenate in ISpell. The simple code is just like this:

char*

MySpellChecker::hyphenate (const char* const word, size_t len,char* tag)

{

if(len==-1) len=strlen(word);

if (len > MAXWORDLEN

|| !g_iconv_is_valid(m_translate_in)

|| !g_iconv_is_valid(m_translate_out))

return 0;

char* result=0;

myspell->hyphenate(word,result,tag);

return result;

}

The concrete code in MySpellChecker is :

void Hunspell::hyphenate( const char* const word, char* result, char* tag )

{

HyphenDict *dict;

char buf[BUFSIZE + 1];

char *hyphens=new char[BUFSIZE + 1];

char ** rep;

int * pos;

int * cut;

/* load the hyphenation dictionary */

string filePath="hyph_";

filePath+=tag;

filePath+=".dic";

if ((dict = hnj_hyphen_load(filePath.c_str())) == NULL) {

fprintf(stderr, "Couldn't find file %s\n",tag);

fflush(stderr);

exit(1);

}

int len=strlen(word);

if (hnj_hyphen_hyphenate2(dict, word, len-1, hyphens, NULL, &rep, &pos, &cut)) {

free(hyphens);

fprintf(stderr, "hyphenation error\n");

exit(1);

}

hnj_hyphen_free(dict);

result=hyphens;

}

1.5 zemberek

The way in Zemberek is same with the two above:

static char*

zemberek_dict_hyphenate (EnchantDict * me, const char *const word)

{

Zemberek *checker;

checker = (Zemberek *) me->user_data;

return checker->hyphenate (word);

}

But the way for the concrete implementation is different from the two. We use zemberek_service

char* Zemberek::hyphenate(const char* word)

{

char* result;

GError *Error = NULL;

if (!dbus_g_proxy_call (proxy, "hecele", &Error,

G_TYPE_STRING,word,G_TYPE_INVALID,

G_TYPE_STRV, &result,G_TYPE_INVALID)) {

g_error_free (Error);

return NULL;

}

char*result=0;

return result;

}

1.6 voikko

The hyphenation implementation in Voikko is easy since Voikko has hyphenaiton’s API.

static char **

voikko_dict_suggest (EnchantDict * me, const char *const word,

size_t len, size_t * out_n_suggs)

{

char **sugg_arr;

int voikko_handle;

voikko_handle = (long) me->user_data;

sugg_arr = voikko_suggest_cstr(voikko_handle, word);

if (sugg_arr == NULL)

return NULL;

for (*out_n_suggs = 0; sugg_arr[*out_n_suggs] != NULL; (*out_n_suggs)++);

return sugg_arr;

}

1. Hyphenation module in Enchant

2011-08-21T05:10:00.000-07:00

1.1 Add hyphenation function in Enchant

Firstly, I add hyphenation method in Enchant:

================the code===========

I think we can combine the hyphenation with spell-checking together, So that we can make the code more flexible. In my opinion, the hyphenation function defines as following:

EnchantDict* enchant_broker_request_dict (EnchantBroker* broker, const

char *const lang); //same as spell-checking

char *enchant_dict_hyphenate(EnchantDict *dict, const char *const word,size_t len);

In order to achieve the function and implement in abstract layer, we need to add hyphenation function in EnchantDict. something like, just as a function pointer:

char* (*hyphenate) (struct str_enchant_dict * me,

const char *const word, size_t len,

size_t * out_n_suggs);

and the function is implement by the backend. Take “ispell” as example:

static char * ispell_dict_hyphenate (EnchantDict * me, const char *const word,

size_t len, size_t * out_n_suggs)

{

ISpellChecker * checker;

checker = (ISpellChecker *) me->user_data;

return checker->hyphenate (word, len, out_n_suggs);

}

Finally, we set the connetion

dict->hyphenate = ispell_dict_hyphenate;

dict->suggest = hspell_dict_hyphenate;

dict->suggest = zemberek_dict_hyphenate;

Summary of What I have done in GSoc2011

2011-08-21T05:09:00.001-07:00

Summary of What I have done in GSoc2011

1 Hyphenation module in Enchant

1.1 Add hyphenation function in Enchant

1.2 Add five backends to support hyphenation

1.3 ISpell

1.4 MySpell

1.5 zemberek

1.6 voikko

1.7 Deploy of enchant in Abiword

1.8 Test in Linux

2 Call the Hyphenation function in Abiword.

3 Simple Implementation of Chinese Spell-Check in Enchant

4 Code Re-factor and debug

5. User interface to manage hyphenation

6. How to Support more languages

6.1 How to support more languages in ISpell

6.2 How to support more languages in mySepll

7. How to extend the enchant function

Until now, my works in GSoc2011 including four parts as following:

1．Hyphenation module in Enchant

Ø Read and get totally understand the source code of Enchant

Ø Reuse the abstract layer of Enchant and add Hyphenation function in Enchant, so that we can add more language easily

Ø Deal with more languages

Ø Add five backend implementation, including ispell, myspell, zemberek, voikko, uspell

Ø Deal with the spelling-checking module

2．Call the Hyphenation function in Abiword.

Ø Find split info using enchant_dict_hyphenate

Ø Split Text_Run to split word pass the line width and keep their format

Ø Deal with user's operation(select, delete, cut, paste)

Ø User can select weather to enable the hyphenation function

3. Simple Implementation of Chinese Spell-Checking in Enchant

Ø Add a simple spell-check framework for Chinese in Enchant

Ø Add library to support

Ø Some survey about Chinese Spell-checking

4. Code Re-factor and debug

Ø Code Re-factor, include keep the code flexible

Ø Debug coding problem

5. User interface to manage hyphenation

Ø Windows, Linux, and Cocoa

6. How to Support more languages

Ø How to support more languages in ISpell

Ø How to support more languages in mySepll

7. How to extend the enchant function

the works in Enchant

2011-08-09T05:24:00.001-07:00

1 add hyphenation function in Enchant
what I have done:
Firstly, I add hyphenation module in Enchant:
================about the code===========
I think we can combine the hyphenation with spell-checking together.
so that we can make the code more flexsible.
In my opinion, we can make code like this:
EnchantDict* enchant_broker_request_dict (EnchantBroker* broker, const
char *const lang); //same as spell-checking
char *enchant_dict_hyphenate(EnchantDict *dict, const char *const
word,size_t len);

===================== 1
In order to achieve this, we need to add hyphenation function in
EnchantDict. something like:
char **(*hyphenate) (struct str_enchant_dict * me,
const char *const word, size_t len,
size_t * out_n_suggs);

======================== 2
and the function is implement by the backend.
static char **
ispell_dict_hyphenate (EnchantDict * me, const char *const word,
size_t len, size_t * out_n_suggs)
{
ISpellChecker * checker;

checker = (ISpellChecker *) me->user_data;
return checker->hyphenate (word, len, out_n_suggs);
}
====================3
finally, we set the connetion

dict->hyphenate = ispell_dict_hyphenate;
dict->suggest = hspell_dict_hyphenate;
dict->suggest = zemberek_dict_hyphenate;

2 add five backends to support hyphenation
including ispell, myspell, zemberek, voikko, uspell

we all know that Enchant has eight types of backend to support multi-language.
USpell
HSpell
ASpell
MySpell....

but I found that in Abiword. we only use two backends:
libenchant_ispell.dll libenchant_myspell.dll

another surprising thing is that in the dictionary\ispell I can only
find one dic: american.hash(En_US)
and the hunspell dic is empty~~

the changes:
1 deleted the unneed connection, such as HSpell
2 add hunspell(myspell) hyphenation code
3 implement hyphenation using hunspell
4 implement hyphenation using Zemberek

================1 deleted the unneed connection, such as HSpell===========
Hebrew dont need any hyphenation
Yiddish dont need any hyphenation

====================2 implement hyphenation using hunspell
added files:
hyphen/hnjalloc.h
hyphen/hnjalloc.c
hyphen/hyph_en_US.dic
hyphen/hyphen.c
hyphen/hyphen.gyp
hyphen/hyphen.h
hyphen/hyphen.patch
hyphen/hyphen.tex

need more tests

==================== 3 implement hyphenation using Zemberek
just using dbus_g_proxy_call:

char* Zemberek::hyphenate(const char* word)
{
char* result;
GError *Error = NULL;
if (!dbus_g_proxy_call (proxy, "hecele", &Error,
G_TYPE_STRING,word,G_TYPE_INVALID,
G_TYPE_STRV, &result,G_TYPE_INVALID)) {
g_error_free (Error);
return NULL;
}

char*result=0;
return result;
}

The attachment is the updated version today. Now we have four backends
of hyphenantion
1 hunspell: using seperated dic: such as hyph_en_us.dic.
we can download dic from internet
2 libhyphenaiton: the dic is provided by author, sometimes limited
3 zemberek: for Turkis
4 Voikko: for Finnish

3 the depot of enchant
I just copy the bulid result of enchant:
enchant\bin\Debug\libenchant_myspell.dll ---->
abiword\msvc2008\Debug\lib\enchant\libenchant_myspell.dll
enchant\bin\Debug\libenchant_ispell.dll ---->
abiword\msvc2008\Debug\lib\enchant\libenchant_ispell.dll
enchant\bin\Debug\libenchant.dll ---->abiword\msvc2008\Debug\bin\ibenchant.dll

3 the implementation of the five backends
4 call hyphenation module of enchant to display the hyphenation-result
in abiword
5 after user's operation, refresh the hyphenation-result accordingly
include user adding new word, delete word, copy word, cut word

6 test in Linux
todo:
1 Fully support hyphenation in Abiword
2 Support more language besides En_us
3 Some tests in Linux(Unix)

Still to improve:
1 code re-factor
2 deal with more language
3 include more user's operation(such as operate with picture may
influence the hyphenation result)

the summary about What I have done in GSoc2011

2011-08-09T05:23:00.001-07:00

my works in GSoc2011 including two parts.
1 the hyphenation module in Enchant
Key: to reuse the abstract layer of Enchant and add Hyphenation function
we can add more language easy
Deal with more languages

2 call in Abiword. including:
split run
find split info
deal with user's operation

new version, but a lot of question~confusing

2011-05-17T08:32:00.001-07:00

Hi, All.

I am working on GSoc Abiword this summer to implement the hyphenation support in Abiword. Before I implement the function, I find some code in Abiword for spell-checking. so I follow the code to implement hyphenation function using enchant. And I have some questiones about enchant. thanks

I want to use enchant to implement hyphenation to keep the dictionary seperately.

the attachment1 is the main class diagram

the attachment2 is the code I implement the hyphenation follow spell-checking code

My question is:

1. Is there some funcition for hyphenation like enchant_dict_hyphenate in Enchant?

2. how the enchant achieve the function? I can track in the code in enchant~

3. give some suggestion to me about my codes, thanks

Thanks very much~

a smiple version.

2011-05-11T18:42:00.000-07:00

a smiple version.
You own the copyright for whatever work you do. All of your work must
be licensed under the GPL2 or later. Please add your name + email
address to the headers of each file that you touch.

Start coding about Hyphenation in ABiword now. One week I can make it a preliminary result~~~

2011-05-04T08:27:00.001-07:00

Start coding about Hyphenation in ABiword now. One week I can make it a preliminary result~~~

wait for me~

patch file_Implement progress bar in windows

2011-04-27T08:25:00.000-07:00

The patch file I have modified in the following spaces, to keep same with the source code:
==================1 ap_usb_ProgressListener======
create a class to deal with ProgressListener(the same as the gtk code). seperate from the statusBarListener
class ap_usb_ProgressListener : public AP_StatusBarFieldListener
{
public:
.............
virtual void notify(); //deal with progressbar update
protected:
HWND m_ProgressWND;
};
==================2======
and in the notify function deal with the update: and i find the place to add pulse process bar
void ap_usb_ProgressListener::notify()
{
if(pProgress->isDefinate())
{
double fraction = pProgress->getFraction();
SendMessage(m_ProgressWND,PBM_SETPOS,fraction*100,0);
}
else
{ //here pulse process bar <--------------pulse process bar
}
}
===========================3============
In this situation, I need to build the connection between ap_usb_ProgressListener and ProcessBar in the createWindow() in this place, your code have one error(the elseif is in the wrong place)
else if(pf->getFillMethod() == PROGRESS_BAR)
{
pf->setListener((AP_StatusBarFieldListener *)(new ap_usb_ProgressListener(pf, m_hwndProgressBar)));
}
===========================4============
Remove unused function and variables

Why should we expose the SpellCheck interface in Enchant

2011-04-27T07:26:00.003-07:00

I have read much code about enchant and want to implement hyphenation using enchant
but I have one question in the FL_DocLayout.cpp where spellcheck used. I think the SpeellManager is enough to deal with our problem, Why should we expose the SpellCheck interface in Enchant. that is not safe

one more question, if we use enchant for abstraction of dictionaries. but most dictionaries have different format. how to analysis the different format of dictionary
I think the analysis of dictionary is done by the library the dictionay provide, the enchant is just Responsible for call it

some different idea?

Share of some understanding about Source code

2011-04-27T07:24:00.002-07:00

Recently I try to implement the process bar in windows. and I read a lot of source code, I make a summary of that. I want to share with you all, I hope that is helpfull to you all.

Anyone interested in that pls disscus with me, Thank you.

the attachment is the class diagram in UML format. we can see that:

1. the AP_StatusBar is an abstract class represent the status bar.

And the Windows AP_Win32StatusBar inherited from AP_StatusBar

And in the AP_StatusBar contain the interface elements——m_vecFields(vector of StatusBarField) and processField(processBar).

But they are all the abstract class AP_StatusBarField. And the concreate class is AP_StatusBarFidld_ProcessBar / ap_sbf_pageInfo /ap_sbf_StatusMessage/ ap_sbf_InputMode / ap_sbf_Language.

AP_StatusBarField_ProcessBar: present the processBar

ap_sbf_pageInfo: present pageInfo

ap_sbf_StatusMessage:present StatusMessage

ap_sbf_InputMode: present InputMode

ap_sbf_Language: present Language

2. And the event-handler of the interface elements are all in the following format:

firstly, creating the event-handler Listener

then build the connection between them

override the notify function in the Listener to handler the event

every interface element has Listener class:

AP_StatusBarFidld_ProcessBar: ap_usb_processListener

ap_sbf_pageInfo: ap_usb_TextListener

ap_sbf_StatusMessage: ap_usb_TextListener

ap_sbf_InputMode: ap_usb_TextListener

ap_sbf_Language: ap_usb_TextListener

all the listener are all inherit from the Ap_StatusBarFieldListener.

and the event are all handled in the notify function.

3. in the AP_Win32StatusBar.

the createWindow function create the HWNDs and make connection with their listener

AP_Win32StatusBar::createWindow:

for (UT_sint32 k = 0; k < getFields()-> getItemCount(); k++)

{

pf-> setListener(...));

}

libhyphenate

2011-04-27T07:24:00.000-07:00

I use libhyphenate to implement the hyphenation sucessfully. And then refer to the source code of libhyphenate.

In libhyphenate, it is easy to carry out the hyphenation.

#include <libhyphenate\Hyphenator.h>

#include <iostream>

using namespace Hyphenate;

using namespace std;

int main () {

Hyphenator(RFC_3066::Language("en")).hyphenate("example.txt","output.txt") ;

return 0;

}

the input is the txt file, and the output file is correctly in the hyphenation format. now, I read the source code of libhyphenate to find what we can refer to libhyphenate.

But I found one problem, the dictionary is not enough in the libhyphenate. And I replace with Webster's New International Dictionary , also have some problems, because the interface is different.

Although the author of libhyphenate make the algorithm and the dictionary seperately, so that you can add your own dictionary to deal with your language.

Some Open Source libraries about hyphenation

2011-04-27T07:22:00.001-07:00

=============================1======================

I think hyphenation is locale dependent because in different languages, some data type such as number and date are different from each other. So we must find a method support for many different Languages besides English. AbiWord is the word processor for everybody, not just English speakers.

=============3 Some Open Source libraries about hyphenation =========================

I have searched some Open Source libraries we can use to determine word break points.

There is a wide range of different free open source solutions for spell-checking and hyphenation by computer.

1. libhyphenate- An hyphenation library for C++, LGPL Hyphenation Library.

Developer Steve Wolter has released Version 1.0 of Libhyphenate, his C++ hyphenation library. Libhyphenate implements the hyphenation algorithm also used by the Tex layout system. The library currently supports hyphenation libraries for English, German and French. More languages can be generated from the corresponding Tex files.

2. In the thesis” Word Hyphenation by Computer” mention a lot of library. I think we can read that.

3. wordaxe : Hyphenation by decomposition of compound words

4. SyFi: A C++ library built on top of the symbolic math library GiNaC.

===============some python and other language libraries we can refer to===============

1 PyHyphen: Hyphenation module for Python programs with the ability to automatically hyphenate words using an algorithm which is based on decomposition of compound words into base words, and is named DCWHyphenator in the code.

2 Pslib is a C-library to create PostScript files on the fly. It offers text rendering including hyphenation, kerning and ligatures.

3 XHTML hyphenator: XHTML hyphenator is a hyphenation program for XHTML documents.

I will spend more time to care about the C++ hyphenation library.

Time Plan about implementation of Hyphenation support in AbiWord

2011-04-27T02:31:00.000-07:00

First version of my time plan. I will make a detailed disscusion with my mentor

Time Plan about implementation of Hyphenation support in AbiWord

Chen Xiajian

Date	Plan to do
Week 1	1 Read more about Enchant and get familiar with the use of Enchant in AbiWord (this step will make an abstraction of the hyphenation algorithm) 2 Search and find more libraries which can be used to determine the breakpoints within words. Includes: Ø Some TeX formatting system Ø Open Source libraries Ø If possible pull out just the code we need from some package. Ø Care about the language factors(besides English) 3 Learn more about Hyphenation algorithm Deliverable 1: Make a summary about Enchant and the open source hyphenation libraries Choose one most suitable for us
Week 2	(continue and finish) 1 Some programming test about Open Source hyphenation libraries 2 Make a code framework about where to add code(to make code more flexible) 3 Design the data structures of Hyphenation 4 Building the hyphenationChecker using open source library in Enchant hyphenationChecker is the name I define in Enchant to deal with hyphenation Deliverable 2: 1 Summary Document 2 Patch about data structures of Hyphenation 3 Make an patch about hyphenationChecker
Week 3	1 Fix possibly remaining bugs to have a good foundation for the further. 2 Read source code and place hyphenation points called from the Enchant The codes in src/text/fmt/xp/.(h,cpp) Ø fb_LineBreaker.(h,cpp) and Ø fb_Alignment.(h,cpp) Deliverable 3:* 1 Make an patch about implementation of hyphenation points 2 Fix remaining bugs
Week 4	1 Draw the hyphenation characters in AbiWord 2 Find more good dictionary to have a good coverage of different language and words Deliverable 4: 1 Make an patch about preliminary results 2 Make a summary of dictionary
Week 5	(continue and finish) According to Martin, it seems that it's a difficult task. Time is needed. 1 Have more tests 2 Again, Fix possibly remaining bugs 3 Prepare some document that Google required in Mid Evaluation Deliverable 5: 1 Fix remaining bugs 2 Some document that Google require
July 15	Mid Evaluation
Week 6	1 Care about some special languages and special words Deliverable 6: 1 Have an more good result to support more language and words
Week 7	Rejoin hyphenated words as they get moved via the users editing. Codes: src/text/fmt/xp/fl_BlockLayout.cpp More tests Deliverable 7: Patch about implementation of this function More tests
Week 8	1 deal with the result: misspell words are correctly handled after hyphenation. 2 Test and Refactor Deliverable 8: 1 Patch about implementation of this function 2 better version
Week 9	(continue and finish) 1 Fix new or remaining bugs 2 Some documents what GsoC needed
Week 10	(continue and finish) Time for emergency
August 16	Suggested 'pencils down' date. Take to scrub code, write tests, improve documentation, etc.
August 26	End

Congratulations!

2011-04-27T02:30:00.000-07:00

Get Selected~

Thank all the people who give me suggestion
I will make a good result in my GSoc2011

my GSoc2011: Add Hyphenation Support to AbiWord