README.md 2.63 KB
Newer Older
1 2 3 4 5 6 7 8 9
Getting started 
---------------

Use a terminal and go to the root of the folder (Wikipedia_to_hdoc).

Generating .hdoc of a Wikipedia article with an URL
---------------------------------------------------

1 - Run the comand corresponding to your OS
Nicolas Lhomme's avatar
Nicolas Lhomme committed
10
        
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
        On windows : 
            runURL.bat yourWikipediaUrl yourFilename
                yourWikipediaUrl is the Wikipedia URL
                yourFilename is the name of the directory in which output files will be placed
                
            For instance : runURL.bat https://fr.wikipedia.org/wiki/Constructeur_(programmation) constructeur
        
        On Linux : 
            sh runURL.sh yourWikipediaUrl yourFilename
                yourWikipediaUrl is the Wikipedia URL
                yourFilename is the name of the directory in which output files will be placed
            
            For instance : sh runURL.sh https://fr.wikipedia.org/wiki/Constructeur_(programmation) constructeur
            
2 - Get the .hdoc in the output/yourFilename folder

Generating .hdoc of a Wikipedia article with a local file
---------------------------------------------------------

lhommeni's avatar
lhommeni committed
30
1 - Copy the content of the Wikipedia article you want to convert in the directory named "input" and in a file called "source.xml".
Nicolas Lhomme's avatar
Nicolas Lhomme committed
31

32
2 - Run the comand corresponding to your OS
Nicolas Lhomme's avatar
Nicolas Lhomme committed
33 34 35
        
        
         windows : 
36 37 38 39 40
            runFile.bat
        
        On Linux : 
            sh runFile.sh
                       
41 42 43 44
3 - Get the .hdoc in the output/source folder

To do
---------------------------------------------------------
lhommeni's avatar
lhommeni committed
45
Concerning images :
46

lhommeni's avatar
lhommeni committed
47
1 - Extract the metadata information from the meta.xml file for each image. You can do that by creating an XSL file that will be called from the ant task generated by xslt/get_ressources_urls.xsl. In that file you have the hand on each meta.xml File.
48 49 50
2 - Verify that images are well zipped to avoid any problem while testing in Opale
3 - Images inside paragraphs break the validation of the hdoc schema, do a preposition to change the schema and handle that.

lhommeni's avatar
lhommeni committed
51 52 53 54
Concerning listings :

1 - Succeed in finding the language of the part of code of the wikipedia article

haroldcb's avatar
haroldcb committed
55 56 57 58 59 60 61

Concerning tables : 

1 - Solve the encoding problem,
2 - Change Hdoc Scheme in order to accept images in tables?
3 - Display complex tables as tables in Opale (not extern files)
 
62 63
Be aware of the following things
---------------------------------------------------------
harriga_merouane@hotmail.fr's avatar
Merge  
harriga_merouane@hotmail.fr committed
64
1 - Not all images have a metadata information (only the ones who )
Nicolas Lhomme's avatar
Nicolas Lhomme committed
65
2 - The title of the images have a metadata information (only the ones who are not included in the text)
66 67 68

BUG
---
Nicolas Lhomme's avatar
Nicolas Lhomme committed
69
1 - Linux sh files doesn't work with UTC proxy but works outside UTC