Commit 4d4b37d5 authored by Harriga Merouane's avatar Harriga Merouane

Updated READ ME

parent 297380da
......@@ -19,17 +19,17 @@ Previous developers
Presentation
---------------
This converter transforms a wikipedia page (from a link or a saved page) to a Hdoc document.
This converter transforms a wkipedia page (from a link or a saved page) to a Hdoc document.
User Documentation
---------------
Use a terminal and go to the folder's root (Wikipedia_to_hdoc).
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
1 - Run the command corresponding to your OS
On windows :
runURL.bat yourWikipediaUrl yourFilename
......@@ -54,7 +54,7 @@ Generating .hdoc of a Wikipedia article with a local file
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.
2 - Run the comand corresponding to your OS
2 - Run the command corresponding to your OS
windows :
......@@ -94,7 +94,7 @@ Concerning tables :
2 - Change Hdoc Scheme in order to accept images in tables?
3 - Display complex tables as tables in Opale (not as extern files).
3 - Display complex tables as tables in Opale (not as extern files)
Technical notes
---------------
......@@ -102,15 +102,15 @@ For images you can refer to the get-ressources-with-meta.xsl and official-met
Be aware of the following things
---------------------------------------------------------
1 - Not all images have a metadata information (only the ones who )
2 - The title of the images have a metadata information (only the ones who are not included in the text)
1 - Not all the images have a metadata information in Wikipedia pages.
2 - The title of images don't exist in the metadata information that you will retrieve. Use the @alt attribute when you have the hand on an image to get it.
BUG
---
1 - Linux sh files doesn't work with UTC proxy but works outside of UTC.
1 - Linux sh file doesn't work with UTC proxy but works outside of UTC.
2 - Random errors might occur
Wikipedia is a great tool : everyone can participe. However, it does not provide contributors with best practices that everyone follows. The result is a lot of different ways to write articles. This is why this converter might not handle some situations (even if all files tried worked), and it might not be able to output some Wikipedia articles at its current state.
Wikipedia is a great tool : everyone can participate. However, it does not provide contributors with best practices that everyone follows. The result is a lot of different ways to write articles. This is why this converter might not handle some situations (even if all files tried worked), and it might not be able to output some Wikipedia articles at its current state.
3 - Small issues with Opale
Links can be invisible if you use an old version of Opale. This is not a problem coming from the Wikipedia to Hdoc converter. Make sure you use an updated version of Opale to test your scar archives.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment