Commits

Anonymous committed d87ae90

Comments (0)

Files changed (1)

 == Welcome ==
 
-Welcome to your wiki! This is the default page we've installed for your convenience. Go ahead and edit it.
+Welcome to the wiki for the project "odt2org". As you can guess by the name of the project, the purpose of this software is to convert from Open Office files (.odt) into emacs org-mode files (.org). Since OpenOffice is able to import files created with Word, there is no need for a "doc2org" converter.
 
-=== Wiki features ===
-
-This wiki uses the [[http://www.wikicreole.org/|Creole]] syntax, and is fully compatible with the 1.0 specification.
-
-The wiki itself is actually a hg repository, which means you can clone it, edit it locally/offline, add images or any other file type, and push it back to us. It will be live immediately.
-
-Go ahead and try:
-
-{{{
-$ hg clone http://bitbucket.org/josemaria.alkala/odt2org/wiki
-}}}
 
 Wiki pages are normal files, with the .wiki extension. You can edit them locally, as well as creating new ones.
 
-=== Syntax highlighting ===
 
-You can also highlight snippets of text, we use the excellent [[http://www.pygments.org/|Pygments]] library.
-
-Here's an example of some Python code:
-
-{{{
-#!python
-
-def wiki_rocks(text):
-	formatter = lambda t: "funky"+t
-	return formatter(text)
-}}}
 
 You can check out the source of this page to see how that's done, and make sure to bookmark [[http://pygments.org/docs/lexers/|the vast library of Pygment lexers]], we accept the 'short name' or the 'mimetype' of anything in there.
 
 + Introduction
 This piece of software converts from Open Office files (.odt) into emacs org-mode files (.org).
 
-++ Download
-* [http://mantiel.wikidot.com/local--files/os:odt2org/odt2org_v1.0.zip odt2org v1.0]: python code distributed with a BSD license.
-* [http://mantiel.wikidot.com/local--files/os:odt2org/test_and_results.zip Tests]: it contain some files and the expected result.
+=== Download ===
+You can download different versions from [[http://bitbucket.org/josemaria.alkala/odt2org/downloads|here]].
 
-++ Installation
-+++ Windows
-1. Install [http://www.python.org python]: I have been using python 2.6.x
-2. Install [http://codespeak.net/lxml/index.html lxml].
-3. Install [http://www.decalage.info/en/python/olefileio OleFileIO]
+=== Installation ===
+==== Windows ====
+1. Install [[http://www.python.org|python]]: I have been using python 2.6.x
+2. Install [[http://codespeak.net/lxml/index.html|lxml]].
+3. Install [[http://www.decalage.info/en/python/olefileio|OleFileIO]].
 
 If you use linux, you probably already know how to install python libraries. The idea is:
 * Unzip/Untar the library
 * Go to the directory where there is a file called: setup.py
 * Install it by mean of a line similar to:
-> C:\python26\python setup.py install
+{{{
+C:\python26\python setup.py install
+}}}
 
-+++ Linux
+==== Linux ====
 Very similar to windows way. (Sorry for being lazy)
 
-+ Usage
+=== Usage ===
 It is very easy to convert files:
 * Produce "filename.org":
 > python odt2org.py filename.odt
 * It extracts files such: images, .pdf, .doc, .xls that may be attached as objects. The files are extracted to the same directory where the output file is created. A link is created to those files.
 * It removes extra spaces/tabs from the paragraphs (this behaviour can be overriden).
 
-+ DOC2ORG
-Note that despite this is not a doc2org converter (that was the original purpose). You can use OpenOffice to convert from .doc to .odt and afterwards this little software to convert from .odt to .doc:
+=== DOC2ORG ===
+Note that despite this is not a doc2org converter (that was the original purpose). You can use OpenOffice to convert from .doc to .odt and afterwards this scripts to convert from .odt to .doc:
 * OpenOffice: convert from .doc to .odt
 * odt2org: covert from .odt to .doc
 
-+ Disclaimer
-I am not a developer and I didn't spend too much time (actually two days) creating the software. I am sharing it hoping it becames useful to you. Or if you are a more serious developer.... you know. 
+=== Disclaimer ===
+I am not a developer, so don't expect for granted the same level of quality that you can get in other softwares out there. Backup your data. Use at your own risk.
 
-So: **Use it at your own risk.**.
+=== Contact the author ===
+You can contact me via [[http://mantiel.wikidot.com/contact|this link]].
 
-Comments, bugs, etc are welcomed. Send them via: [http://mantiel.wikidot.com/contact contact me]
-
-+ License
-I haven't taken a look to the licenses. It will be opensource that is for sure (in fact, currently I am providing the source code). I haven't had the chance to look into it to choose one.
-
-+ History
+=== History ===
+* Nov'10: major review of the code. Moved to bitbucket. Licensed as [[http://www.apache.org/licenses/LICENSE-2.0.html|Apache License 2.0]].
 * 2010-04-19: a bug in the paths corrected. Now, by default, it replaces many spaces/tabs by just one space in paragraphs.
 * 2010-04-18: some refactoring of the code. Corrections done when dealing with enumerations.
 * 2010-04-17: corrected a bug where the original file was being overwriten. Command line improved.
-* 2009-08-12: first version with main functionality.
+* 2009-08-12: first version with main functionality.
+
+==== About this wiki ====
+
+This wiki can be managed offline by mean of doing:
+
+{{{
+$ hg clone http://bitbucket.org/josemaria.alkala/odt2org/wiki
+}}}
+
+Check [[http://pygments.org/docs/lexers/|the vast library of Pygment lexers]] for more details.