Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Converted docx text of the Recommendation ITU-T G.191 to Markdown #101

Merged
merged 2 commits into from
Oct 30, 2018

Conversation

ludomal
Copy link
Member

@ludomal ludomal commented Oct 15, 2018

Related to #40.

These markdown files will allow easier editing to the Recommendation. STL2009 text was used as base text.

The recommendation was split in three files (Main, Annex A, Annex B). These files will then be used by the Editor of G.191 to prepare the draft text to be submitted to the ITU.

The Markdown can be converted to HTML using pandoc. Then the generated HTML code can be open in MS Word.

Pandoc can convert to docx directly however highlights seem to be lost in the process.

@dennisguse
Copy link
Member

About the hyperlink: depends on what is needed for.
By default, Pandocs generates for each caption <h>-elements including id.
So, these could be referenced by hyperlink to provide go to links.
However, if the content of the caption is changed, the id changes as well.
So, if the captions change often, it might be better to manually provide anchor targets (and define the id manually).

user@noname:/tmp$ cat test.md 
# Headline1 

Test
Test

## Headline2

Test
Test

Results in:

user@noname:/tmp$ pandoc --from markdown --to html test.md 
<h1 id="headline1">Headline1</h1>
<p>Test Test</p>
<h2 id="headline2">Headline2</h2>
<p>Test Test</p>

@dennisguse
Copy link
Member

@ludomal
I am not entirely sure, but are the original files the markdown files were generated from already in this repository?
Otherwise it would be nice to add a link pointing to the files into the commit message.
This way it would be known on where the content initially came from.

@ludomal
Copy link
Member Author

ludomal commented Oct 16, 2018

@dennisguse, I will remove the hyperlinks and let pandoc generate them.

With regards to the original file, I did put a note at the top of the document to let the community knows that this is not the official document and that it can be found on the ITU website, with a link. The document is contained in a zip file.

Alternatively, we could upload the PDF on Github?

@ludomal
Copy link
Member Author

ludomal commented Oct 17, 2018

Hyperlinks are now removed.

@dennisguse dennisguse added this to the STL2018 milestone Oct 25, 2018
@dennisguse dennisguse self-requested a review October 25, 2018 04:51
Copy link
Member

@dennisguse dennisguse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's merge it.
We just need to be careful - at the moment, there are a lots of non-generated text files, which outdated rather quickly.
At some point in future, we need to switch to at least auto-generate the technical documentation.

@dennisguse
Copy link
Member

@ludomal If you are also satisfied - please merge :)

@ludomal ludomal merged commit d8621db into openitu:dev Oct 30, 2018
@ludomal ludomal deleted the g191_text_markdown branch October 30, 2018 01:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants