Commit eeb34a39 authored by Fabien Boucaud's avatar Fabien Boucaud

Update README.md

parent 25142265
...@@ -16,7 +16,7 @@ http://www.gnu.org/licenses/gpl-3.0.txt ...@@ -16,7 +16,7 @@ http://www.gnu.org/licenses/gpl-3.0.txt
- Fecherolle Cécile - Fecherolle Cécile
## Presentation ## Presentation
This module is able to convert several [framad](https://framapad.org/) files (exported as html files) to the hdoc format. This module is able to convert several [framapad](https://framapad.org/) files (exported as html files) to the hdoc format.
## User documentation ## User documentation
...@@ -32,15 +32,14 @@ Vous êtes un utilisateur de framapad et en créez un pour un projet. Après avo ...@@ -32,15 +32,14 @@ Vous êtes un utilisateur de framapad et en créez un pour un projet. Après avo
## Product Backlog ## Product Backlog
Currently available on: https://framemo.org/framapad_to_opale Currently (january 2017) available on: https://framemo.org/framapad_to_opale
See also : https://bimestriel.framapad.org/p/nf29_framapad_to_opale for the full documentation of our working process. See also : https://bimestriel.framapad.org/p/nf29_framapad_to_opale for the full documentation of our working process.
## TODO ## TODO
- Indentation - Code tags
- Titles (and therefore Structure of the doc)
- Code
- Markdown - Markdown
- Tags for typing the structure
## Technical notes ## Technical notes
### Description of framapad_to_hdoc.ant ### Description of framapad_to_hdoc.ant
...@@ -55,7 +54,9 @@ See also : https://bimestriel.framapad.org/p/nf29_framapad_to_opale for the full ...@@ -55,7 +54,9 @@ See also : https://bimestriel.framapad.org/p/nf29_framapad_to_opale for the full
- Apply html2xhtmlv1.xsl : this xsl is used as a fix and adds br tag at the end of lists (ul and ol) - Apply html2xhtmlv1.xsl : this xsl is used as a fix and adds br tag at the end of lists (ul and ol)
- Apply html2xhtmlv2.xsl : this xsl surround text line with p tags and transforms non-hdoc tags into hdoc tags as s, u, strong tags. - Apply html2xhtmlv2.xsl : this xsl surround text line with p tags and transforms non-hdoc tags into hdoc tags as s, u, strong tags.
- Apply html2xhtml3.xsl : this xsl is used as a fix, it deletes p tags when its child is ul or ol - Apply html2xhtml3.xsl : this xsl is used as a fix, it deletes p tags when its child is ul or ol
- Apply xhtml2hdoc.xsl : this xsl transforms the content into hdoc structure - Apply html2hdocstruct1 to 6 : those xsl files are dedicated to building the hdoc structure based on the titles <h1> to <h6>
- Apply html2hdocstructdivsection: this xsl completes the sections created in the previous xsl with <div> around the actual content of each level
- Apply xhtml2hdoc.xsl : this xsl transforms the content into hdoc structure and changes the namespace
#### Post-transformations actions #### Post-transformations actions
- Build hdoc structure - Build hdoc structure
...@@ -64,10 +65,14 @@ See also : https://bimestriel.framapad.org/p/nf29_framapad_to_opale for the full ...@@ -64,10 +65,14 @@ See also : https://bimestriel.framapad.org/p/nf29_framapad_to_opale for the full
### Supported tags ### Supported tags
- html tags -> hdoc tags - html tags -> hdoc tags
- u, s, em, strong -> em - u, s, em, strong, color -> em
- sub -> sub
- sup -> sup
- li -> li - li -> li
- ol -> ol - ol -> ol
- br -> p - br -> p
## Capitalisation ## Capitalisation
Using regular expression with xsl is a good way to parse a non xml file. Using regular expression with xsl is a good way to parse a non xml file.
We can note about the creation of the hdoc's structure with the titles <h1> to <h6> that XSLT is probably not the best tool for these specific transformations. Something like SAX, which actually explore the XML files sequentially, would probably be more efficient and easier to use for these kinds of transformations.
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