README.md 1.56 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_opale).

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 .scar in the output/yourFilename folder

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

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

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

BUG
---

1 - Linux sh files doesn't work with UTC proxy but works outside UTC