README.md 2.69 KB
Newer Older
Harriga Merouane's avatar
Harriga Merouane committed
1 2 3 4 5 6 7 8 9 10
Converter : Wikipedia To Opale
==============================

Licence : 
---------------
GPL 3.0
http://www.gnu.org/licenses/gpl-3.0.txt


Credits :
11
---------------
Harriga Merouane's avatar
Harriga Merouane committed
12 13 14 15 16 17 18 19 20 21 22 23
Carrel Billiard Harold

Harriga Merouane

Lhomme Nicolas

Previous developers


Presentation
------------

Harriga Merouane's avatar
Harriga Merouane committed
24
Wikipedia to Opale is a converter that transforms Wikipedia pages to Opale.
Harriga Merouane's avatar
Harriga Merouane committed
25

Harriga Merouane's avatar
Harriga Merouane committed
26
Dependence
Harriga Merouane's avatar
Harriga Merouane committed
27 28 29 30 31 32 33
---------
-   Wikipedia To Hdoc Converter
-   Hdoc to Opale Converter


User Documentation
------------------
34 35 36 37

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

Harriga Merouane's avatar
Harriga Merouane committed
38
1 - Run the command corresponding to your OS
Nicolas Lhomme's avatar
Nicolas Lhomme committed
39
        
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
        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
59
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
60 61 62
    Display the source code of the wikipedia page, copy it and paste it in the new file source.xml
    Make sure to copy/paste the source code and not save it directly as a file.
    
Harriga Merouane's avatar
Harriga Merouane committed
63
2 - Run the command corresponding to your OS
Nicolas Lhomme's avatar
Nicolas Lhomme committed
64
        
65 66 67 68 69 70
        On windows : 
            runFile.bat
        
        On Linux : 
            sh runFile.sh
                       
71 72 73 74 75
3 - Get the .scar in the output/source folder

BUG
---

Harriga Merouane's avatar
Harriga Merouane committed
76 77 78 79 80
1 - Linux sh files doesn't work with UTC proxy but works outside UTC

Unsupported
-----------
1   Images:
Harriga Merouane's avatar
Harriga Merouane committed
81
    -   Images inside text are not supported because of schema validation.
Harriga Merouane's avatar
Harriga Merouane committed
82 83 84

To do
-----
Harriga Merouane's avatar
Harriga Merouane committed
85 86 87 88
1   Images:
    -   Do a preposition to modify the hdoc schema so that we will be able to manage images inside text
    -   Complete the extraction of the metadata information of images

Harriga Merouane's avatar
Harriga Merouane committed
89 90 91 92


Technical notes
---------------
Harriga Merouane's avatar
Harriga Merouane committed
93
For images you can refer to the get-ressources-with-meta.xsl and official-meta.xml in the hdoc_to_wikipedia/xslt Folder Read the commentary. It will help you to finish the task regarding images. These files are included to give you a solution to start from.