= XML Copy Editor !HowTo = == How do I build from source on Windows? == The first step is to install Dev-C++ and the relevant libraries. I'd like to be able to say that there's a quick way of doing this, but unfortunately this is not the case. (On Linux it's trivial, but I appreciate that often we don't have a choice in that regard.) I recommend using the DLLs that ship with the binary download of XCE. In the case of Xerces-C, this saves you the trouble of building from source in msys. For PCRE, make sure you build the library with Unicode support or download a version that has Unicode enabled. For Libxml and Libxslt I have used the Zlatkovic binaries and headers. (Zlatkovic also provides iconv etc.) For wxWidgets I recommend Fred Cailleau-Lepetit's excellent Unicode !DevPaks for Dev-C++ (be sure to install both headers and the library). The source itself should compile without warnings except for a few Xerces-C linker warnings – on Linux the same source compiles against Xerces-C without them. For Aspell, simply download the Windows port of the current *-dev package from the GNU project to fetch aspell.h. That done, you can download the full binary installer. All you will need is the DLL (the executable itself is not needed). === Useful links === [http://www.bloodshed.net/devcpp.html Bloodshed Dev-C++] [[br]] [http://xerces.apache.org/xerces-c/download.cgi Xerces-C] [[br]] [http://gnuwin32.sourceforge.net/packages/pcre.htm PCRE] (the PCRE home page at http://www.pcre.org/ suggests this port is slightly out of date though) [[br]] [http://www.zlatkovic.com/libxml.en.html Zlatkovic.com Libxml, Libxslt, etc.] [[br]] [http://cfred.free.fr/download.php Fred Cailleau-Lepetit's wxWidgets DevPaks] (alternatively, you could always download wxWidgets from [http://www.wxwidgets.org/downloads/ the official wxWidgets download page]) [[br]] [http://aspell.net/win32/ GNU Aspell Windows port] == How do I go about creating a new translation? == === Contributed by SHiNE CsyFeK === === '''1. Translate''' === '''''1) For Linux users''''' [[br]] That's quite easy. Download Xml-copy-editor(called XCE below :P), [[br]] unpack it. Go to the source directory src. Here you can see many ".cpp" [[br]] files and ".h" files. Input command: {{{ $ xgettext -k_ --from-code=utf-8 *.cpp *.h }}} then you get a "messages.po" in the directory. That's the ".po" file we [[br]] need to translate. You need a tool to help you finish the translation [[br]] job. I recommend poedit, a fast and light-weight translation tool. [[br]] You can get it from http://www.poedit.net/ or http://poedit.sf.net/ . [[br]] They are the same. Install it then use to open the ".po" file, There are a few things need to be filled into the poedit. Run poedit, [[br]] select "File"-"Preferences", fill in your name and email address blanks. [[br]] Back to main window, select "Catalog"-"Settings", fill the items like [[br]] below: "Project name and version:" -> "XML Copy Editor (your source version)" [[br]] "Team:" -> "(your translation team)" [[br]] "Team's email address:" -> "(your team's email address)" [[br]] "Language:" -> "(your native language)" [[br]] "Country:" -> "(your country)" [[br]] "Charset:" -> "(charset you currently using. utf-8 would be better)" [[br]] "Source code and charset:" -> "utf-8" [[br]] "Plurals Forms:" -> "nplurals=2; plural=(n != 1)" OK! Now go to the main window and the rest thing is ... translate them [[br]] all! :P When you've finished translating the ".po" file, you can use: {{{ $ msgfmt messages.po }}} to get the ".mo" file. Send the ".po" and ".mo" files to XCE's authors [[br]] email box. '''''2) For Windows users''''' [[br]] Like in Linux, we should get XCE's source code and poedit windows [[br]] version. Uncompress the source and install poedit in "c:\poedit", then [[br]] open a "Command Window" by executing "cmd.exe". Go to the XCE's source [[br]] directory, run: {{{ c:\poedit\bin\xgettext.exe -k_ --from-code=utf-8 *.cpp *.h }}} to a messages.po file. Setup poedit the same as in the Linux part, then [[br]] open the ".po" file you just created and translate all items. When you [[br]] close poedit, a "messages.mo" will be made automatically. === '''2. Update translation''' === '''''1) For Linux users''''' [[br]] Create a new version of "messages.po" file and rename it to "msg-new.po". [[br]] Copy the old version ".po" file to the same directory and rename it to [[br]] "msg-old.po", then run: {{{ $ msgmerge msg-old.po msg-new.po >output.po }}} the "output.po" file is the new version of ".po" file with old [[br]] translations added. Then translate the "output.po" file. '''''2) For Windows users''''' [[br]] Do the first part as Linux users, then run: {{{ c:\poedit\bin\msgmerge.exe msg-old.po msg-new.po > output.po }}} translate the "output.po" file. Written by SHiNE CsyFeK <[mailto:csyfek@gmail.com csyfek@gmail.com]> [[br]] 2007.10.13 == '''How To Build XML-Copy-Editor 1.2.0.2 under Ubuntu 8.10''' == I don't know who would look at this but I did find troubles building XML-Copy-Editor under Linux. [[br]] Make sure that you have the required libraries installed first; these are the following libraries that my system needs before I build * libwxgtk2.8-dev * libboost-dev * libxerces-c2-dev * libxml2-dev * libxslt-dev * libpcre++-dev {{{ $configure }}} this script will check for all the prerequisite libraries. If requirements are met, this script will generate a make script. Once the configure completes, run make command {{{ $make }}} After several minutes depending on your system, go to ./src directory, you will see the Xml-Copy-Editor executable. === To install === {{{ $make install }}} '''NOTE:''' if you run and cannot see icon or images in the error dialog, this is because xmlcopyeditor points to wrong directory. This can fixed by changing the application directory in Preferences ---- [[br]] if you didn't have a chance to read the INSTALL, here it is (1.2.0.4): === Basic Installation === These are generic installation instructions. The {{{`}}}configure' shell script attempts to guess correct values for [[br]] various system-dependent variables used during compilation. It uses [[br]] those values to create a {{{`}}}Makefile' in each directory of the package. It may also create one or more {{{`}}}.h' files containing system-dependent [[br]] definitions. Finally, it creates a shell script {{{`}}}config.status' that [[br]] you can run in the future to recreate the current configuration, a file {{{`}}}config.cache' that saves the results of its tests to speed up [[br]] reconfiguring, and a file {{{`}}}config.log' containing compiler output [[br]] (useful mainly for debugging {{{`}}}configure'). If you need to do unusual things to compile the package, please try [[br]] to figure out how {{{`}}}configure' could check whether to do them, and mail [[br]] diffs or instructions to the address given in the {{{`}}}README' so they can [[br]] be considered for the next release. If at some point {{{`}}}config.cache' [[br]] contains results you don't want to keep, you may remove or edit it. The file {{{`}}}configure.in' is used to create {{{`}}}configure' by a program [[br]] called {{{`}}}autoconf'. You only need {{{`}}}configure.in' if you want to change [[br]] it or regenerate {{{`}}}configure' using a newer version of {{{`}}}autoconf'. The simplest way to compile this package is: 1. {{{`}}}cd' to the directory containing the package's source code and type {{{`}}}./configure' to configure the package for your system. If you're [[br]] using {{{`}}}csh' on an old version of System V, you might need to type [[br]] {{{`}}}sh ./configure' instead to prevent {{{`}}}csh' from trying to execute [[br]] {{{`}}}configure' itself. [[br]] > [[br]] Running {{{`}}}configure' takes a while. While running, it prints some [[br]] messages telling which features it is checking for. [[br]] > 1. Type {{{`}}}make' to compile the package. > 1. Type {{{`}}}make install' to install the programs and any data files and documentation. [[br]] > 1. You can remove the program binaries and object files from the source code directory by typing {{{`}}}make clean'. [[br]] > === Compilers and Options === Some systems require unusual options for compilation or linking that [[br]] the {{{`}}}configure' script does not know about. You can give {{{`}}}configure' [[br]] initial values for variables by setting them in the environment. Using [[br]] a Bourne-compatible shell, you can do that on the command line like [[br]] this: {{{ CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure }}} Or on systems that have the {{{`}}}env' program, you can do it like this: {{{ env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure }}} === Compiling For Multiple Architectures === You can compile the package for more than one kind of computer at the [[br]] same time, by placing the object files for each architecture in their [[br]] own directory. To do this, you must use a version of {{{`}}}make' that [[br]] supports the {{{`}}}VPATH' variable, such as GNU {{{`}}}make'. {{{`}}}cd' to the [[br]] directory where you want the object files and executables to go and run [[br]] the {{{`}}}configure' script. {{{`}}}configure' automatically checks for the [[br]] source code in the directory that {{{`}}}configure' is in and in {{{`}}}..'. If you have to use a {{{`}}}make' that does not supports the {{{`}}}VPATH' [[br]] variable, you have to compile the package for one architecture at a time [[br]] in the source code directory. After you have installed the package for [[br]] one architecture, use {{{`}}}make distclean' before reconfiguring for another [[br]] architecture. === Installation Names === By default, {{{`}}}make install' will install the package's files in{{{`}}}/usr/local/bin', {{{`}}}/usr/local/man', etc. You can specify an installation prefix other than {{{`}}}/usr/local' by giving {{{`}}}configure' the option {{{`}}}--prefix=PATH'. You can specify separate installation prefixes for [[br]] architecture-specific files and architecture-independent files. If you [[br]] give {{{`}}}configure' the option {{{`}}}--exec-prefix=PATH', the package will use [[br]] PATH as the prefix for installing programs and libraries. [[br]] Documentation and other data files will still use the regular prefix. If the package supports it, you can cause programs to be installed [[br]] with an extra prefix or suffix on their names by giving {{{`}}}configure' the [[br]] option {{{`}}}--program-prefix=PREFIX' or {{{`}}}--program-suffix=SUFFIX'. === Optional Features === Some packages pay attention to {{{`}}}--enable-FEATURE' options to{{{`}}}configure', [[br]] where FEATURE indicates an optional part of the package. They may also pay attention to {{{`}}}--with-PACKAGE' options, where PACKAGE [[br]] is something like {{{`}}}gnu-as' or {{{`}}}x' (for the X Window System). The {{{`}}}README' should mention any {{{`}}}--enable-' and {{{`}}}--with-' options that the [[br]] package recognizes. For packages that use the X Window System, {{{`}}}configure' can usually [[br]] find the X include and library files automatically, but if it doesn't, [[br]] you can use the {{{`}}}configure' options {{{`}}}--x-includes=DIR' and {{{`}}}--x-libraries=DIR' to specify their locations. === Specifying the System Type === There may be some features {{{`}}}configure' can not figure out [[br]] automatically, but needs to determine by the type of host the package [[br]] will run on. Usually {{{`}}}configure' can figure that out, but if it prints [[br]] a message saying it can not guess the host type, give it the {{{`}}}--host=TYPE' option. TYPE can either be a short name for the system [[br]] type, such as {{{`}}}sun4', or a canonical name with three fields: [[br]] CPU-COMPANY-SYSTEM See the file {{{`}}}config.sub' for the possible values of each field. If {{{`}}}config.sub' isn't included in this package, then this package doesn't [[br]] need to know the host type. If you are building compiler tools for cross-compiling, you can also [[br]] use the {{{`}}}--target=TYPE' option to select the type of system they will [[br]] produce code for and the {{{`}}}--build=TYPE' option to select the type of [[br]] system on which you are compiling the package. === Sharing Defaults === If you want to set default values for {{{`}}}configure' scripts to share, [[br]] you can create a site shell script called {{{`}}}config.site' that gives [[br]] default values for variables like {{{`}}}CC', {{{`}}}cache_file', and {{{`}}}prefix'. {{{`}}}configure' looks for {{{`}}}PREFIX/share/config.site' if it exists, then {{{`}}}PREFIX/etc/config.site' if it exists. Or, you can set the {{{`}}}CONFIG_SITE' environment variable to the location of the site script. A warning: not all {{{`}}}configure' scripts look for a site script. === Operation Controls === {{{`}}}configure' recognizes the following options to control how it [[br]] operates. '''--cache-file=FILE''' [[br]] Use and save the results of the tests in FILE instead of {{{`}}}./config.cache'. Set FILE to {{{`}}}/dev/null' to disable caching, for [[br]] debugging {{{`}}}configure'. '''--help''' [[br]] Print a summary of the options to {{{`}}}configure', and exit. '''--quiet''' [[br]] '''--silent''' [[br]] '''-q''' [[br]] Do not print messages saying which checks are being made. '''--srcdir=DIR''' [[br]] Look for the package's source code in directory DIR. Usually {{{`}}}configure' can determine that directory automatically. '''--version''' [[br]] Print the version of Autoconf used to generate the {{{`}}}configure' [[br]] script, and exit. {{{`}}}configure' also accepts some other, not widely useful, options. [[br]] Written by Anh Trinh ([mailto:ant.2710@gmail.com anh.trinh.n@gmail.com]) [[br]] 2009.03.31