-

Author: Roman Elokhin (Europe)

README.md

@@ -80,16 +80,29 @@ Was tested for Windows 10.
 - install Python3 with YAML and pywin32 packages (win32com.client)
 - install Pandoc
 - install any MarkDown editor. I use Typora. Any simple text editor can be used, but this is not very convenient
-
-## Files
-- <a href="https://github.com/nihole/md2docx/blob/master/render.py">render.py</a> - Python script. Takes data from the markdown file, converts and inserts it into a Word document
-- <a href="https://github.com/nihole/md2docx/blob/master/structure.yml">structure.yml</a> - YAML file with all the necessary parameters for render.py
+- copy folder 'example' to your local git repository. Change the name of the folder in accordance with your project. Now you can use this folder for new documentation creation
+- change mkword.py file: 
+  - change the path to the script/render.py file
+  - you may change the path to ./structure.yml
+- change or create appropriate Word template file
+- change in accordance with your documentation structure.yml file
+- create MarkDown file
+- execute python3 mkword.py
+- new Word file will be created from your MarkDown file
+- now you can use git for documentation creation
+
+## Files in Example
+- <a href="https://github.com/nihole/md2docx/blob/master/render.py">render.py</a> - Python script. Takes data from the markdown file, converts and inserts it into a Word document. This is a static file. You usually don't need to change it. You even don't need to copy this file to your local git repository but you need to add the path to this file into mkword.py file
+- <a href="https://github.com/nihole/md2docx/blob/master/structure.yml">structure.yml</a> - YAML file with all the necessary parameters for render.py. Normally you adjust this file only once at the beginning. You have to add the path to this file into the mkword.py file
+- folder templates - folder with Word templates
 - template.docx is a Word document that we are going to fill out with the context of markdown documents. This Word document should have all the styles, templates ... you are going to use. This document is divided manually into sections. Each section corresponds to one chapter
-- <a href="https://github.com/nihole/md2docx/blob/master/example_chapter.md">example_chapter.md</a> - markdown document with example information
-- <a href="https://github.com/nihole/md2docx/tree/master/initial">initial folder</a> - initial files
+- folder media - folder with pictures
+- <a href="https://github.com/nihole/md2docx/blob/master/example_chapter.md">example_chapter.md</a> - markdown document with example information. Of course, for your documentation, the name will differ. You have to add the path to this file into mkword.py file
+- mkword.py - python script with the references to render.py and structure.yml files.
 
 ## How to start
-- python3 render.py
+- cd example
+- python3 mkword.py
 - yes
 - yes
 

example/example_chapter.md

@@ -0,0 +1,248 @@
+# Example Chapter
+
+
+
+## h2 Heading
+
+### h3 Heading
+#### h4 Heading
+##### h5 Heading
+###### h6 Heading
+
+
+## Horizontal Rules
+
+___
+
+---
+
+***
+
+
+## Typographic replacements
+
+Enable typographer option to see result.
+
+(c) (C) (r) (R) (tm) (TM) (p) (P) +-
+
+test.. test... test..... test?..... test!....
+
+!!!!!! ???? ,,  -- ---
+
+"Smartypants, double quotes" and 'single quotes'
+
+
+## Emphasis
+
+**This is bold text**
+
+__This is bold text__
+
+*This is italic text*
+
+_This is italic text_
+
+~~Strikethrough~~
+
+
+## Blockquotes
+
+
+> Blockquotes can also be nested...
+> > ...by using additional greater-than signs right next to each other...
+> >
+> > > ...or with spaces between arrows.
+
+
+## Lists
+
+Unordered
+
++ Create a list by starting a line with `+`, `-`, or `*`
++ Sub-lists are made by indenting 2 spaces:
+  - Marker character change forces new list start:
+    * Ac tristique libero volutpat at
+    + Facilisis in pretium nisl aliquet
+    - Nulla volutpat aliquam velit
++ Very easy!
+
+Ordered
+
+1. Lorem ipsum dolor sit amet
+2. Consectetur adipiscing elit
+3. Integer molestie lorem at massa
+
+
+1. You can use sequential numbers...
+1. ...or keep all the numbers as `1.`
+
+Start numbering with offset:
+
+57. foo
+1. bar
+
+
+## Code
+
+Inline `code`
+
+Indented code
+
+    // Some comments
+    line 1 of code
+    line 2 of code
+    line 3 of code
+
+
+Block code "fences"
+
+```
+Sample text here...
+```
+
+Syntax highlighting
+
+``` js
+var foo = function (bar) {
+  return bar++;
+};
+
+console.log(foo(5));
+```
+
+## Tables
+
+Table: Left aligned columns
+| Option | Description |
+| ------ | ----------- |
+| data   | path to data files to supply the data that will be passed into templates. |
+| engine | engine to be used for processing templates. Handlebars is the default. |
+| ext    | extension to be used for dest files. |
+
+
+Table: Right aligned columns
+| Option | Description |
+| ------:| -----------:|
+| data   | path to data files to supply the data that will be passed into templates. |
+| engine | engine to be used for processing templates. Handlebars is the default. |
+| ext    | extension to be used for dest files. |
+
+
+## Links
+
+[link text](http://dev.nodeca.com)
+
+[link with title](http://nodeca.github.io/pica/demo/ "title text!")
+
+Autoconverted link https://github.com/nodeca/pica (enable linkify to see)
+
+
+## Images
+
+![Minion](media/minion.png)  
+Figure: Minion
+
+!["Stormtroopocat"](media/stormtroopocat.jpg)  
+Figure: Stormtroopocat  
+
+
+## Plugins
+
+The killer feature of `markdown-it` is very effective support of
+[syntax plugins](https://www.npmjs.org/browse/keyword/markdown-it-plugin).
+
+
+### [Emojies](https://github.com/markdown-it/markdown-it-emoji)
+
+> Classic markup: :wink: :crush: :cry: :tear: :laughing: :yum:
+>
+> Shortcuts (emoticons): :-) :-( 8-) ;)
+
+see [how to change output](https://github.com/markdown-it/markdown-it-emoji#change-output) with twemoji.
+
+
+### [Subscript](https://github.com/markdown-it/markdown-it-sub) / [Superscript](https://github.com/markdown-it/markdown-it-sup)
+
+- 19^th^
+- H~2~O
+
+
+### [\<ins>](https://github.com/markdown-it/markdown-it-ins)
+
+++Inserted text++
+
+
+### [\<mark>](https://github.com/markdown-it/markdown-it-mark)
+
+==Marked text==
+
+
+### [Footnotes](https://github.com/markdown-it/markdown-it-footnote)
+
+Footnote 1 link[^first].
+
+Footnote 2 link[^second].
+
+Inline footnote^[Text of inline footnote] definition.
+
+Duplicated footnote reference[^second].
+
+[^first]: Footnote **can have markup**
+
+    and multiple paragraphs.
+
+[^second]: Footnote text.
+
+
+### [Definition lists](https://github.com/markdown-it/markdown-it-deflist)
+
+Term 1
+
+:   Definition 1
+with lazy continuation.
+
+Term 2 with *inline markup*
+
+:   Definition 2
+
+        { some code, part of Definition 2 }
+    
+    Third paragraph of definition 2.
+
+_Compact style:_
+
+Term 1
+  ~ Definition 1
+
+Term 2
+  ~ Definition 2a
+  ~ Definition 2b
+
+
+### [Abbreviations](https://github.com/markdown-it/markdown-it-abbr)
+
+This is HTML abbreviation example.
+
+It converts "HTML", but keep intact partial entries like "xxxHTMLyyy" and so on.
+
+*[HTML]: Hyper Text Markup Language
+
+### [Custom containers](https://github.com/markdown-it/markdown-it-container)
+
+::: warning
+*here be dragons*
+:::
+
+### Anchors
+
+[this is  a link](#anchor)
+
+[this is anchor]{#anchor}
+
+Comments:
+
+<!-- This is commented out. -->
+[comment]:
+
+
+

example/media/dojocat.jpg

@@ -0,0 +1,23 @@
+import os
+import sys
+
+render_path = '../scripts/render.py'
+
+structure_path  = './structure.yml'
+
+######### Main Body ######################
+
+
+######### get file's names from the command line ####################
+if not (len(sys.argv)==1):
+    print ("   ######################################################\n")
+    print ("   Syntax is:\n")
+    print ("   python3 mkword.py\n")
+    print ("   Change paths in mkword.py if needed.\n")
+    print ("   ######################################################\n")
+    quit()
+
+cmd = 'python %s %s' % (render_path, structure_path)
+
+returned_value = os.system(cmd)
+

example/media/md2word_work_flow.png

@@ -0,0 +1,65 @@
+# visible, save, close: yes/no, change script behaviour
+# structure_verification: yes/no, verify if the 1st header in the section is correct
+# change_data: yes/no, replace or not data inside the section with the data received from md file
+# table_style: yes/no, change or not the table style in this section
+# table_caption: yes/no, insert or not captions for the tables in this section based of the caption in the md file
+# figure_caption: yes/no, insert or not captions for the figures in this section based of the caption in the md file
+# update_fields: yes/no, update or not fields for whole word document
+
+
+script:
+  word:
+    visible: True
+    save: "no"
+    close: "no"
+  actions:
+    structure_verification: "yes"
+    change_data: "yes"
+    table_style: "yes"
+    table_caption: "yes"
+    figure_caption: "yes"
+    update_fields: "yes"
+  
+
+# table_style: table style
+# dest_word_file: path ot the word (docx) document
+    
+general:
+  table_style: "AS Table"
+  dest_word_file: "templates/template.docx"
+
+# 
+# Manually split the word document into sections.
+# 
+# number: the number of the section (1,2,...)
+# name: the first title in the section. Scipt verifies if this title is really the first title if the section with the number above.
+# md_file: the path to the md file fom which you are going to take data 
+# action:  if "ignore" then will be ignored
+#
+
+sections:
+- number: 4
+  name: "Chapter 1"
+  description: ""
+  md_file: ""
+  action: "ignore"
+- number: 5
+  name: "Chapter 2"
+  description: ""
+  md_file: ""
+  action: "ignore"
+- number: 6
+  name: "Chapter 3"
+  description: ""
+  md_file: ""
+  action: "ignore"
+- number: 7
+  name: "Example Chapter"
+  description: ""
+  md_file: "example_chapter.md"
+  action: ""
+- number: 8
+  name: "Chapter 100"
+  description: ""
+  md_file: ""
+  action: "ignore"

example/media/minion.png

@@ -0,0 +1,2 @@
+for tmp word files
+