Compare commits

...

3 commits

6 changed files with 267 additions and 16 deletions

8
.gitignore vendored
View file

@ -1,3 +1,7 @@
*.png !logos/logo.jpg
*.jpg logos/*.png
logos/*.jpg
logos/*.pdf
Thumbs*
*.pdf *.pdf

79
jmk-tep.yaml Normal file
View file

@ -0,0 +1,79 @@
# This is the standard/template style for JMK Engineering Reports. I am only changing the parts that make the documents look "good" as I go.
# Rev 0
# Date: 2022-09-20
#
# Revision History
#
# 0 - Initial version for technical memos
pageSetup:
size: Letter
spacing-header: 10mm
spacing-footer: 10mm
margin-top: 1cm
margin-bottom: 1cm
margin-left: 2.5cm
margin-right: 2.5cm
fontsAlias:
stdFont: calibri
headingFont: Helvetica-Bold
styles:
normal:
parent: base
fontSize: 11
fontName: stdFont
heading:
parent: normal
fontName: headingFont
fontSize: 20
textColor: '#747474'
#textColor: '#990033'
heading1:
parent: heading
fontSize: 18
heading2:
parent: heading
fontSize: 16
heading3:
parent: heading
fontSize: 16
heading4:
parent: heading
fontSize: 14
heading5:
parent: heading
fontSize: 12
title:
parent: heading
fontSize: 30
txtheader:
parent: heading
headertable:
borderWidth: 1
borderColor: red
parent: heading
align: center
headerlogor:
align: center
headerlogol:
valign: middle
item-list:
# Added some space after a bulleted list to make things a bit cleaner
spaceAfter: 10pt
colWidths:
# The defualt is 20, but that only allows single digit numbers
- 30pt
# I left this as null
- null
bullet-list:
# Added some space after a bulleted list to make things a bit cleaner
spaceBefore: 0
spaceAfter: 10pt

View file

@ -6,6 +6,8 @@
# #
# 0 - Initial version that is good enough to send to clients # 0 - Initial version that is good enough to send to clients
pageSetup: pageSetup:
size: Letter size: Letter
spacing-header: 10mm spacing-header: 10mm
@ -19,41 +21,52 @@ fontsAlias:
stdFont: calibri stdFont: calibri
headingFont: Helvetica-Bold headingFont: Helvetica-Bold
linkColor: black
styles: styles:
bodytext:
alignment: TA_LEFT
normal: normal:
parent: base parent: base
fontSize: 11 fontSize: 11
fontName: stdFont fontName: stdFont
heading: header:
alignment: TA_CENTER
parent: normal parent: normal
heading:
keepWithNext: true
parent: normal
spaceAfter: 6
spaceBefore: 12
fontName: headingFont fontName: headingFont
fontSize: 20
textColor: 17365D textColor: 17365D
heading1: heading1:
parent: heading parent: heading
fontSize: 18 fontSize: 175%
spaceBefore: 10
spaceAfter: 10
heading2: heading2:
parent: heading parent: heading
fontSize: 16 fontSize: 150%
heading3: heading3:
parent: heading parent: heading
fontSize: 16 fontSize: 125%
heading4: heading4:
parent: heading parent: heading
fontSize: 14 fontSize: 112%
heading5: heading5:
parent: heading parent: heading
fontSize: 12 fontSize: 100%
title: title:
parent: heading parent: heading
fontSize: 30 fontSize: 30
align: right
txtheader: txtheader:
parent: heading parent: heading
headertable: headertable:
borderWidth: 1 borderWidth: 0
borderColor: red borderColor: red
parent: heading parent: heading
align: center align: center
@ -61,16 +74,18 @@ styles:
align: center align: center
headerlogol: headerlogol:
valign: middle valign: middle
mytable:
parent: table
colWidths: [3cm, 6cm, 3cm]
item-list: item-list:
# Added some space after a bulleted list to make things a bit cleaner
spaceAfter: 10pt spaceAfter: 10pt
colWidths: colWidths:
# The defualt is 20, but that only allows single digit numbers
- 30pt - 30pt
# I left this as null
- null - null
bullet-list: bullet-list:
# Added some space after a bulleted list to make things a bit cleaner
spaceBefore: 0
spaceAfter: 10pt spaceAfter: 10pt

37
jmkengineering.yaml Normal file
View file

@ -0,0 +1,37 @@
{
"pageSetup" : {
"size": "Letter",
},
"fontsAlias" : {
"stdFont": "Calibri",
"headingFont": "Calibri Light"
},
"styles" : [
["normal" , {
"fontSize": 12
}],
["heading" , {
"parent": "normal",
"fontName": "headingFont",
"fontSize": 20,
"textColor": "#0000ff"
}],
["heading1" , {
"parent": "heading",
"fontSize": 18,
}],
["heading2" , {
"parent": "heading",
"fontSize": 16,
}],
["heading3" , {
"parent": "heading",
"fontSize": 14,
}],
["title" , {
"parent": "heading",
"fontSize": 40
}]
]
}

BIN
static/watermark.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.9 KiB

116
template-short-memo.rst Normal file
View file

@ -0,0 +1,116 @@
.. Here are some notes about setting up the files
.. rst2pdf -s "C:\Users\jeff\JMK Engineering Inc\Engineering - Documents\General\common\jmk.yaml" <this document>.rst
.. ==== -> Heading 1
.. ---- -> Heading 2
.. ~~~~ -> Heading 3
.. ^^^^ -> Heading 4
.. """" -> Heading 5
.. This changes for section numbers, remove is "typical" numbering is good.
.. section-numbering::
.. This sets the page counter to roman
.. raw:: pdf
SetPageCounter 1 lowerroman
.. This is the setup for the header substitutions. Sometimes there will be a second logo
.. |logo| image:: common/logo.jpg
:height: 2cm
.. |Revision| replace:: A
.. |Client| replace:: Internal
.. |Date| replace:: Aug 2022
.. |ProjectNum| replace:: xxxx
.. header::
.. class:: headertable
.. list-table::
:widths: 20 50 20
* -
- **###Title###**
- |Date|
* -
- CLIENT: |Client|
- Rev: |Revision|
* - |logo|
- Proj. Num: |ProjectNum|
- Page ###Page###
.. footer::
`JMK Engineering Inc. <https://jmkengineering.com>`__
.. This is where I will be adding any other text and image substitutions that will be needed throughout the "typical" specification
.. |Title| replace:: The Main title
.. |SubTitle| replace:: The subject title
===========
|Title|
===========
--------------
|SubTitle|
--------------
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.. For a simply memo or living project document, the revision history is likely not needed, remove if necessary.
.. list-table:: Revision History
:widths: 15 50 20 15
* - A
- Initial Template Submission
- August 24, 2022
-
* - **Number**
- **Description**
- **Date**
- **Approved**
.. Page break after the title page
.. raw:: pdf
PageBreak
.. This sets up the page break and re-set the page numbering - Only if I figure out how to do a table of contents
.. .. raw:: pdf
PageBreak
SetPageCounter 1 arabic
.. 26 05 00 - Common work Results for electrical
Common
======