├── .gitignore
├── Fonts
├── Apache License.txt
├── FontAwesome.ttf
├── OpenSans-Bold.ttf
├── OpenSans-Italic.ttf
├── OpenSans-LightItalic.ttf
└── OpenSans-Regular.ttf
├── LICENSE.txt
├── Makefile
├── README.md
├── Vagrantfile
├── dapper-invoice.cls
└── example.tex
/.gitignore:
--------------------------------------------------------------------------------
1 | *.aux
2 | *.log
3 | *.out
4 | *.pdf
5 | *.gz
6 | .vagrant/
7 |
--------------------------------------------------------------------------------
/Fonts/Apache License.txt:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
--------------------------------------------------------------------------------
/Fonts/FontAwesome.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mkropat/dapper-invoice/11d753c6b3e8c2e866476307617c924331002d03/Fonts/FontAwesome.ttf
--------------------------------------------------------------------------------
/Fonts/OpenSans-Bold.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mkropat/dapper-invoice/11d753c6b3e8c2e866476307617c924331002d03/Fonts/OpenSans-Bold.ttf
--------------------------------------------------------------------------------
/Fonts/OpenSans-Italic.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mkropat/dapper-invoice/11d753c6b3e8c2e866476307617c924331002d03/Fonts/OpenSans-Italic.ttf
--------------------------------------------------------------------------------
/Fonts/OpenSans-LightItalic.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mkropat/dapper-invoice/11d753c6b3e8c2e866476307617c924331002d03/Fonts/OpenSans-LightItalic.ttf
--------------------------------------------------------------------------------
/Fonts/OpenSans-Regular.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mkropat/dapper-invoice/11d753c6b3e8c2e866476307617c924331002d03/Fonts/OpenSans-Regular.ttf
--------------------------------------------------------------------------------
/LICENSE.txt:
--------------------------------------------------------------------------------
1 | The MIT License (MIT)
2 |
3 | Copyright (c) 2015 Michael Kropat
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 | # Makefile forked from Mike Wilcox's resume project Makefile [1]
2 | #
3 | # [1] https://github.com/mjw56/mike-wilcox-latex-resume/blob/master/Makefile
4 |
5 | .SUFFIXES: .tex .pdf
6 |
7 | .PHONY : default install uninstall clean pdf watch
8 |
9 | REPORT = example
10 | SHOW = $(REPORT)
11 |
12 | $(REPORT).pdf: $(REPORT).tex dapper-invoice.cls
13 |
14 | default: pdf
15 |
16 | pdf: $(REPORT:%=%.pdf)
17 |
18 | .tex.pdf:
19 | xelatex $* && xelatex $*
20 |
21 | watch: pdf
22 | @echo watching \'$(SHOW).tex\' to run \'$(MAKE) pdf\'
23 | @ruby -e "file = '$(SHOW).tex'" \
24 | -e "command = '$(MAKE) pdf'" \
25 | -e "lm = File.mtime file" \
26 | -e "while true do" \
27 | -e " m = File.mtime file" \
28 | -e " system command unless m==lm" \
29 | -e " lm = m" \
30 | -e " sleep 0.25" \
31 | -e "end"
32 |
33 | install: dapper-invoice.cls
34 | mkdir -p "$$(kpsewhich -expand-var '$$TEXMFHOME')/tex/latex/base"
35 | cp -a $? "$$(kpsewhich -expand-var '$$TEXMFHOME')/tex/latex/base/"
36 |
37 | uninstall:
38 | rm -f "$$(kpsewhich -expand-var '$$TEXMFHOME')/tex/latex/base/dapper-invoice.cls"
39 |
40 | clean:
41 | rm -rf $(REPORT:%=%.aux) $(REPORT:%=%.bbl) $(REPORT:%=%.blg)
42 | rm -rf $(REPORT:%=%.log) $(REPORT:%=%.toc) $(REPORT:%=%.dvi)
43 | rm -rf $(REPORT:%=%.ind) $(REPORT:%=%.ilg) $(REPORT:%=%.nls)
44 | rm -rf $(REPORT:%=%.nlo) $(REPORT:%=%.out)
45 | rm -rf $(REPORT:%=%.pdf)
46 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | ## dapper-invoice
2 |
3 | A billable-time invoice featuring style over substance.
4 |
5 | 
6 |
7 | ### Pre-Requisites
8 |
9 | - [TeX Live](https://www.tug.org/texlive/acquire-netinstall.html)
10 | - TeX xetex (siunitx.sty)
11 | - TeX science (fontawesome.sty)
12 |
13 | — or —
14 |
15 | - [Vagrant](https://www.vagrantup.com/downloads.html)
16 |
17 | — or —
18 |
19 | - [Docker](https://www.docker.com/get-started)
20 |
21 | ### Generating an Invoice
22 |
23 | #### Using TeX Live Locally
24 |
25 | ```
26 | cp example.tex your-invoice-101.tex
27 | # make some changes to your-invoice-101.tex
28 | make your-invoice-101.pdf
29 | ```
30 |
31 | Your invoice will be created as `your-invoice-101.pdf`
32 |
33 | #### Using Vagrant
34 |
35 | ```
36 | cp example.tex your-invoice-101.tex
37 | vagrant up # this may take a while the first time
38 | vagrant ssh -c 'cd /vagrant; make REPORT=your-invoice-101 watch'
39 | ```
40 |
41 | Now whenever you make changes to `your-invoice-101.tex` on your host machine,
42 | the watcher inside the VM will automatically build `your-invoice-101.pdf`,
43 | which will be saved back to the host machine.
44 |
45 | When finished editing, input Control-C to stop the
46 | watcher, then run:
47 |
48 | ```
49 | vagrant halt
50 | ```
51 |
52 | #### Using Docker
53 |
54 | Use Docker Hub's [`blang/latex`](https://hub.docker.com/r/blang/latex/) image that comes with a matching .sh file.
55 | When you first run this .sh file, it will pull the docker image that includes
56 | all of the latex dependencies.
57 |
58 | ```
59 | wget https://raw.githubusercontent.com/blang/latex-docker/master/latexdockercmd.sh
60 | chmod +x latexdockercmd.sh
61 | ./latexdockercmd.sh # will pull down image on first use
62 | ```
63 |
64 | Then, you can use the .sh file as you would xelatex:
65 |
66 | ```
67 | cp example.tex your-invoice-101.tex
68 | latexdockercmd.sh xelatex [options] your-invoice-101.tex
69 | ```
70 |
71 | You invoice will be created as `your-invoice-101.pdf`
72 |
73 | ### Documentation
74 |
75 | See [example.tex](example.tex) and [dapper-invoice.cls](dapper-invoice.cls) for details.
76 |
77 | ### Inspiration
78 |
79 | I am not a designer. Inspiration for the design comes from
80 | borrowing design ideas from good looking invoices people have published
81 | [on the
82 | net](http://www.smashingmagazine.com/2009/11/05/invoice-like-a-pro/). The
83 | resulting design is not even in the same league, but I think it gets the job
84 | done.
85 |
86 | I am also not a LaTeX author. The code borrows heavily from the
87 | [moderncv](https://launchpad.net/moderncv) package (which I can't recommend
88 | enough), as well as numerous other packages.
89 |
90 | ### Licensing
91 |
92 | The code I have written I release under the MIT license.
93 |
94 | Two different font packages are included in the repo for convenience:
95 |
96 | - OpenSans (Apache License v2.00)
97 | - Font Awesome (SIL OFL 1.1)
98 |
--------------------------------------------------------------------------------
/Vagrantfile:
--------------------------------------------------------------------------------
1 | # -*- mode: ruby -*-
2 | # vi: set ft=ruby :
3 |
4 | VAGRANTFILE_API_VERSION = "2"
5 |
6 | Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
7 | config.vm.box = "ubuntu/xenial64"
8 |
9 | config.vm.provider "virtualbox" do |v|
10 | v.memory = 1024 # necessary to avoid 'I can't write on file' errors
11 | end
12 |
13 | config.vm.provision "shell", inline: \
14 | 'apt update && apt install -y make texlive texlive-fonts-extra texlive-latex-extra texlive-science texlive-xetex lmodern'
15 | end
16 |
--------------------------------------------------------------------------------
/dapper-invoice.cls:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mkropat/dapper-invoice/11d753c6b3e8c2e866476307617c924331002d03/dapper-invoice.cls
--------------------------------------------------------------------------------
/example.tex:
--------------------------------------------------------------------------------
1 | \documentclass[letterpaper]{dapper-invoice}
2 | %\documentclass[letterpaper,currency=dollar]{dapper-invoice}
3 | %\documentclass[letterpaper,currency=euro]{dapper-invoice}
4 | %\documentclass[letterpaper,currency=pound]{dapper-invoice}
5 |
6 | \newcommand{\invoiceNo}{101}
7 | \newcommand{\balance}{137.50}
8 | \newcommand{\duein}{15}% days
9 |
10 | \newcommand{\me}{Your~Name}
11 | \newcommand{\clientName}{Sample~Client}
12 |
13 | \setmetadata{\me}{Your Biz}{\invoiceNo}{\clientName}
14 |
15 | \defaultfontfeatures{ Path = ./Fonts/ }
16 | \usepackage{fontawesome}
17 |
18 | \begin{document}
19 |
20 | \newfontface\mainLightItalic{OpenSans-LightItalic}
21 | \makeheader{Your\ \mainLightItalic Biz}{\invoiceNo}
22 |
23 | \twocolumnlayout{
24 | \begin{infoSection}
25 | \infoBox{Client}{\clientName \\
26 | 123 Street Address \\
27 | City, State 55555 }
28 | \infoBox{Project}{\#123.456}
29 | \infoBox{Contact}{Jane Smith}
30 | \infoSub{\faMobilePhone}{\small\slshape +1~(555)~555-5555}
31 | \infoSub{\tiny\faEnvelope}{\small\slshape \emaillink{client@example.com}}
32 | \noalign{\addvspace{8ex}}
33 | \infoBox{}{
34 | {\large\raisebox{.55\height}\currencysym\huge\formatcurrency{\balance} \arrowbase} \\
35 | {\small\color{subduedColor} due \duedate{\duein}}
36 | }
37 | \end{infoSection}
38 | }{
39 | \begin{infoSection}
40 | \infoBox{\arrowtarget Payable To}{
41 | \me \\
42 | 1234 Sycamore Ave \\
43 | Blacksburg, VA 24060
44 | }
45 | \infoSub{\faMobilePhone}{\small\slshape +1~(555)~555-5555}
46 | \infoSub{\tiny\faEnvelope}{\small\slshape \emaillink{you@example.com}}
47 | \end{infoSection}
48 | }
49 |
50 | \drawarrow
51 |
52 | \addvspace{4ex}
53 |
54 | \begin{hoursItemizationWithProject}
55 |
56 | \lineitemp{2015/4/11}{2}{50}{Invoice}{
57 | \item Discussed requirements with client}
58 |
59 | \lineitemp{2015/4/11}{1.25}{50}{Invoice}{
60 | \item Wrote Invoice in LaTeX}
61 |
62 | \lineitemp{2015/4/11}{0.5}{50}{Invoice}{
63 | \item Packaged Invoice in .cls file}
64 |
65 | \beginsummary
66 |
67 | \summaryline{Total}{\currencysym\formatcurrency{\InvoiceTotal}}
68 |
69 | \summaryline{Paid}{\currencysym\formatcurrency{50}}
70 | \summaryline{Balance Due}{\currencysym\formatcurrency{\balance}} % not really any math support (yet)
71 |
72 | \end{hoursItemizationWithProject}
73 |
74 | \end{document}
75 |
--------------------------------------------------------------------------------