Commit e3eba698 authored by Marco Cavalli's avatar Marco Cavalli
Browse files

Merge branch 'feature/md_to_docx_converter_update' into 'master' 

md_to_docx_converter feat frontpage to be also in frontmatter, fix minor...

See merge request !15
parents 6a0cd1e4 3655d532

md_to_docx_converter/Dockerfile

+3 −1
Original line number Diff line number Diff line
@@ -7,6 +7,7 @@ ARG TARGETARCH=amd64 
RUN apt-get update && apt-get install -y \

    wget \

    curl \

    chromium \

    git \

    nodejs \

    npm \
@@ -14,6 +15,7 @@ RUN apt-get update && apt-get install -y \ 
    python3 \

    python3-uno \

    imagemagick \

    qpdf \

    && rm -rf /var/lib/apt/lists/*



# Install Prettier globally

md_to_docx_converter/Dockerfile.cicd

+6 −3
Original line number Diff line number Diff line
@@ -7,10 +7,12 @@ ARG TARGETARCH 
RUN echo "Building for architecture: ${TARGETARCH}"



ENV PYTHONUNBUFFERED=1 \

    PIP_NO_CACHE_DIR=1

    PIP_NO_CACHE_DIR=1 \

    UNO_PYTHON=/usr/bin/python3



# Install system dependencies required by convert.py and helper scripts

RUN apt-get update && apt-get install -y --no-install-recommends \

    chromium \

    curl \

    git \

    imagemagick \
@@ -18,6 +20,7 @@ RUN apt-get update && apt-get install -y --no-install-recommends \ 
    python3-uno \

    nodejs \

    npm \

    qpdf \

    wget \

    && rm -rf /var/lib/apt/lists/*
@@ -73,5 +76,5 @@ RUN git config --system --add safe.directory "*" 
VOLUME ["/app/GENERATED_FILES", "/data/sources"]



# Pass docker run args directly to convert.py

ENTRYPOINT ["python", "convert.py"]

ENTRYPOINT ["python", "/app/convert.py"]

CMD ["--help"]

md_to_docx_converter/INPUT/README.md

0 → 100644
+11 −0
Original line number Diff line number Diff line 
# User Inputs Folder



This folder is used to contain various input files introduced to the script.



## Contents



**file_order**: Intended to contain various file ordering JSONS that follow the [template](../templates/json/file_order.json).



**settings**: Intended to specify the conversion steps to be executed, allowing the user to choose which operations to run or skip. An example of the file can be found in the [template](../templates/json/settings.json) folder.



**html_to_pdf**:  Intended to convert the index.html into a pdf file. Guide lines to write a yaml file for the configuration can be found [here](./html_to_pdf/README.md). An example of the configuration can be found in the [template](../templates/yaml/pdf.config.yaml) folder.
 
 No newline at end of file

md_to_docx_converter/INPUT/file_order/README.md

0 → 100644
+65 −0
Original line number Diff line number Diff line 
# File Orderings



Place JSON files here that define how files contained in the conversion source directory should be ordered.



### Considerations



#### Ensure files defined in the JSON exist in the source directory



Unlike when using the script's default file ordering, a file that is defined in a file ordering provided to the script that is not present in the conversion source directory will cause the script to fail. It is important to make sure that any files defined in a provided JSON are present.



#### Preceding numbers in top-level headings override the script ordering



In the top-level heading of each Markdown file, a leading number (for example, `# 4 Clause Heading) will override the file order defined in the script. It is important to ensure that:

1. No two Markdown source files use the same preceding number in their top-level heading. It is best to make sure the numbers correspond with the file's intended place in the overall hierarchy.

2. Numbering of non-standard clauses and annexes begins with **4**, because **1**, **2**, and **3** are reserved for the predefined clauses *Scope*, *References*, and *Definitions*.



### Example



The following example specifies the ordering of a few example files. An [empty template](../../templates/json/file_order.json) is provided for convenience.



``` json

{

  "clauses": [

    "clause-example1",

    "clause-example3",

    "clause-example2",

    "example4"

  ],

  "annexes": [

    "annex-example1",

    "annex-3",

    "example2"

  ]

}

```



This will ensure that the following file order is produced.



1. **Universal ETSI initial files**

    1. Intellectual Property Rights

    2. Foreword

    3. Modal verbs terminology

    4. Executive summary

    5. Introduction

2. **ETSI universal initial clauses**

    1. Scope

    2. References

    3. Definition of terms, symbols and abbreviations

3. **Clauses defined in the JSON**

    1. *clause-example1.md*

    2. *clause-example3.md*

    3. *clause-example2.md*

    4. *example4.md*

4. **Other clauses**[^1]

5. **Annexes defined in the JSON**

    1. *annex-example1.md*

    2. *annex-3.md*

    3. *example2.md*

6. **Other annexes**[^2]

7. **Universal ETSI final files**

    1. History



[^1]: If any other files exist in the conversion source directory whose filenames follow the format *clause-{text}.md*, they will be added alphabetically after the JSON-defined clauses.



[^2]: Similar to [^1], any files in the source directory that follow the format *annex-{text}.md* will be added alphabetically after the JSON-defined annexes.
 
 No newline at end of file

md_to_docx_converter/README.md

+176 −101

File changed.

Preview size limit exceeded, changes collapsed.