Difference between revisions of "Wikipedia fa/my DVD/workpackages"

From Kiwix
Jump to navigation Jump to search
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Task1: Windows port==
== Task1: Windows port==
; purpose
; purpose
: Make a Windows (2000/XP/VISTA/7) x86_32 version of Kiwix. That means make working Makefiles and DLLs of/for the following 3 XPCOM components ([http://kiwix.svn.sourceforge.net/viewvc/kiwix/moulinkiwix/src/components/zimAccessor/ zimAccessor], [http://kiwix.svn.sourceforge.net/viewvc/kiwix/moulinkiwix/src/components/zimXapianIndexer/ zimXapianIndexer], [http://kiwix.svn.sourceforge.net/viewvc/kiwix/moulinkiwix/src/components/xapianAccessor/ xapianAccessor])
: Make a Windows (2000/XP/VISTA/7) x86_32 version of Kiwix. That means make working Makefiles and DLLs of/for the following 3 XPCOM components ([http://kiwix.svn.sourceforge.net/viewvc/kiwix/moulinkiwix/src/components/zimAccessor/ zimAccessor], [http://kiwix.svn.sourceforge.net/viewvc/kiwix/moulinkiwix/src/components/zimXapianIndexer/ zimXapianIndexer], [http://kiwix.svn.sourceforge.net/viewvc/kiwix/moulinkiwix/src/components/xapianAccessor/ xapianAccessor]). The compilation process must run in a POSIX environment (mingw) with GNU Makefiles and using the MS compiler (cl.exe) and linker (link.exe).


; constraints
; constraints
Line 9: Line 9:
: Must compile on [http://download.kiwix.org/dev/MozillaBuildSetup-1.4.exe mingw]
: Must compile on [http://download.kiwix.org/dev/MozillaBuildSetup-1.4.exe mingw]
: Must compile with MS cl.exe
: Must compile with MS cl.exe
: Components must be compiled staticaly
: Components must be compiled statically
: Provide support during 6 months following the due date.
: Providing support during 6 months following the due date.


; due date
; due date
Line 24: Line 24:
; contact
; contact
: emmanuel _at_ engelhart.org
: emmanuel _at_ engelhart.org
; faq
:; Which version of the code source should be ported?
::''Use this [http://tmp.kiwix.org/src/nightly/kiwix-svn-2010-02-19.tar.bz2 archive]
:; Where are the dependences?
::''All what is necessary should be available [http://download.kiwix.org/dev/ here]. Visual Studio Express can be downloaded from MS Web site.
:; Which parts of Kiwix sources should run on Windows?
::''Only the client should be ported... actualy that means the XPCOM components in src/components
:; How do I know if it works?
::''You should be able to view/index/search through a ZIM file without issue. Concretely, if the 3 components register by starting xulrunner, the job is 99% done. There is a check [http://kiwix.svn.sourceforge.net/viewvc/kiwix/moulinkiwix/kiwix/chrome/content/main/js/tools.js?revision=1150&view=markup here].
:; What does it mean... components have to register?
::''Please read [https://developer.mozilla.org/en/Troubleshooting_XPCOM_components_registration that].
:; Where may I download a test ZIM file?
::''[http://tmp.kiwix.org/zim/0.9/ here]
:; Should I compile the dependences or use the released binaries?
::''If possible (should be always possible except for xz-utils) yes. Constraints are the same as for Kiwix itself (GNU Makefile if necessary, doc, ...)
:; Should I compile also xulrunner?
::''Like you want. This is not mandatory... if not use the binary version of the SDK and runtime [http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases/1.9.1.7/ here]
:; Do I have to work on the code itself?
::''No, you should not... if this seems necessary, contact immediatly Emmanuel. In any case, this is not part of the workpackage/contract.
:; How may I commit my work?
::''The whole stuff should be available on the subversion repository of Kiwix. Please communicate your sourceforge nickname to Emmanuel and he will allow you SVN commit.
:; Where should I have a look if I have specific questions?
::''Contact asap Emmanuel per email, jabber (kelson -at- kiwix.org) or visit the IRC #kiwix channel on Freenode.
:; How to compile the client with Windows:
::''Read [http://www.kiwix.org/index.php/Development/en this page]''


== Task2: Windows installer ==
== Task2: Windows installer ==
Line 34: Line 72:
: Must have a full documentation about how to build the installer
: Must have a full documentation about how to build the installer
: Must provide a global script or Makefile doing all what is necessary to do.
: Must provide a global script or Makefile doing all what is necessary to do.
: Provide support during 6 months following the due date.
: Providing support during 6 months following the due date.
: Must compile on [http://download.kiwix.org/dev/MozillaBuildSetup-1.4.exe mingw]
: Must compile on [http://download.kiwix.org/dev/MozillaBuildSetup-1.4.exe mingw]


Line 58: Line 96:
: Must provide a global script or Makefile doing all what is necessary to do.
: Must provide a global script or Makefile doing all what is necessary to do.
: Must compile on [http://download.kiwix.org/dev/MozillaBuildSetup-1.4.exe mingw]
: Must compile on [http://download.kiwix.org/dev/MozillaBuildSetup-1.4.exe mingw]
: Provide support during 6 months following the due date.
: Providing support during 6 months following the due date.


; due date
; due date

Latest revision as of 09:21, 10 March 2010

Task1: Windows port

purpose
Make a Windows (2000/XP/VISTA/7) x86_32 version of Kiwix. That means make working Makefiles and DLLs of/for the following 3 XPCOM components (zimAccessor, zimXapianIndexer, xapianAccessor). The compilation process must run in a POSIX environment (mingw) with GNU Makefiles and using the MS compiler (cl.exe) and linker (link.exe).
constraints
Must work with GNU Makefiles
Must be fully documented
Must provide a global script or Makefile doing all what is necessary to do (from downloading the dependence source code to provide a tar.gz with kiwix for Windows).
Must compile on mingw
Must compile with MS cl.exe
Components must be compiled statically
Providing support during 6 months following the due date.
due date
2010-02-15
paid
2000$
additional informations
There is already a prototype: binary and sources (search for the WinStudio project files).
Dependences are gecko-sdk, xapian, libunac, libzip2, zlib, liblzma (see here).
contact
emmanuel _at_ engelhart.org
faq
Which version of the code source should be ported?
Use this archive
Where are the dependences?
All what is necessary should be available here. Visual Studio Express can be downloaded from MS Web site.
Which parts of Kiwix sources should run on Windows?
Only the client should be ported... actualy that means the XPCOM components in src/components
How do I know if it works?
You should be able to view/index/search through a ZIM file without issue. Concretely, if the 3 components register by starting xulrunner, the job is 99% done. There is a check here.
What does it mean... components have to register?
Please read that.
Where may I download a test ZIM file?
here
Should I compile the dependences or use the released binaries?
If possible (should be always possible except for xz-utils) yes. Constraints are the same as for Kiwix itself (GNU Makefile if necessary, doc, ...)
Should I compile also xulrunner?
Like you want. This is not mandatory... if not use the binary version of the SDK and runtime here
Do I have to work on the code itself?
No, you should not... if this seems necessary, contact immediatly Emmanuel. In any case, this is not part of the workpackage/contract.
How may I commit my work?
The whole stuff should be available on the subversion repository of Kiwix. Please communicate your sourceforge nickname to Emmanuel and he will allow you SVN commit.
Where should I have a look if I have specific questions?
Contact asap Emmanuel per email, jabber (kelson -at- kiwix.org) or visit the IRC #kiwix channel on Freenode.
How to compile the client with Windows
Read this page

Task2: Windows installer

purpose
Make a Windows installer for Kiwix and Kiwix content (ZIM files and Xapian search indexes)
constraints
Must use NSIS (Nullsoft Scriptable Install System)
Must have standard install/uninstall process
Must have a full documentation about how to build the installer
Must provide a global script or Makefile doing all what is necessary to do.
Providing support during 6 months following the due date.
Must compile on mingw
due date
2010-02-15
paid
500$
additional informations
There is already something, code needs to be adapted: ISO of the last version and code
contact
emmanuel _at_ engelhart.org

Task3: Windows DVD launcher

purpose
Make a DVD launcher (run by the autorun) to give the choice over run/install/exit Kiwix
constraints
Must use a specific code base
Must have a full documentation about how to build the installer
Must provide a global script or Makefile doing all what is necessary to do.
Must compile on mingw
Providing support during 6 months following the due date.
due date
2010-02-15
paid
300$
additional informations
contact
emmanuel _at_ engelhart.org