Skip to content

Commit 7abc408

Browse files
fixes #13 - include generated PDF in HTML site
- generate the PDF in appendix folder - add generated PDF to .gitignore - add a thumbnail of the PDF in images - add link to PDF in appendix chapter
1 parent 73242fe commit 7abc408

File tree

4 files changed

+14
-2
lines changed

4 files changed

+14
-2
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
/MANIFEST
1212
/site
1313
/pdf
14+
/docs/9-appendix/PLSQL-and-SQL-Coding-Guidelines.pdf
1415

1516
# Distribution files
1617
/dist

docs/9-appendix/appendix.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
# Appendix
22

3-
## A - Mapping new guidelines to prior versions
3+
## A - PL/SQL & SQL Coding Guidelines as PDF
4+
5+
These guidelines are primarily produced in [HTML](https://trivadis.github.io/plsql-and-sql-coding-guidelines/) using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).
6+
7+
However, we provide these guidelines also as [PDF](PLSQL-and-SQL-Coding-Guidelines.pdf) produced by [wkhtmltopdf](https://wkhtmltopdf.org/).
8+
9+
[![Trivadis PL/SQL & SQl Coding Guidelines in PDF format](../images/pdf-thumbnail.png)](PLSQL-and-SQL-Coding-Guidelines.pdf)
10+
11+
The formatting is not perfect, but it should be adequate for those who want to work with offline documents.
12+
13+
## B - Mapping new guidelines to prior versions
414

515
Old Id | New Id | Text | Severity | Change-ability | Efficiency | Maintain-ability | Portability | Reliability | Reusability | Security | Testability
616
:-----: | :-----:| ---- | :------: | :------------: | :--------: | :--------------: | :---------: | :---------: | :---------: | :------: | :---------:

docs/images/pdf-thumbnail.png

30.5 KB
Loading

tools/run-in-container/genpdf.sh

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ function create_target_dir(){
77

88
function copy_resources() {
99
cp ${DATA_DIR}/mkdocs.yml ${TARGET_DIR}/mkdocs.yml
10+
cp -r ${DATA_DIR}/custom-theme ${TARGET_DIR}/custom-theme
1011
cp -r ${DATA_DIR}/docs/images ${TARGET_DIR}/docs
1112
cp -r ${DATA_DIR}/docs/stylesheets ${TARGET_DIR}/docs/stylesheets
1213
}
@@ -73,7 +74,7 @@ function convert_to_pdf(){
7374
cover ../docs/cover.html \
7475
toc \
7576
--xsl-style-sheet stylesheets/toc.xsl \
76-
index.html ${DATA_DIR}/PLSQL-and-SQL-Coding-Guidelines.pdf
77+
index.html ${DATA_DIR}/docs/9-appendix/PLSQL-and-SQL-Coding-Guidelines.pdf
7778
}
7879

7980
DATA_DIR="$(cd "$(dirname "${0}")/../.." && pwd)"

0 commit comments

Comments
 (0)