Coder Social home page Coder Social logo

rugk / ifg-letter-appeal Goto Github PK

View Code? Open in Web Editor NEW
11.0 3.0 4.0 1.93 MB

A LaTeX template for appeals to official notifications of agencies to (German) “Freedom of information” (FOI) requests, in German the Informationsfreiheitsgesetz (IFG).

Home Page: https://forum.okfn.de/t/latex-briefvorlage-fuer-widersprueche/1248?u=rugk

License: Other

TeX 100.00%
latex latex-template ifg foi freedom-of-information informationsfreiheit fragdenstaat

ifg-letter-appeal's Introduction

German translation

ifg-letter-appeal

stable-ci

A LaTeX template for appeals to official notifications of agencies to (German) “Freedom of information” (FOI) requests, in German the Informationsfreiheitsgesetz (IFG). Created for and suggested to be used with FragDenStaat.

Currently only available in German.

Example

The included text is mostly intended as an example. Also, it includes some common arguments/boilerplate text you may re-use.

preview image of the first page preview image of the second page

The PDF of this compiled template can also be downloaded.

Building

We recommend a current Tex distribution, e.g. TexLive 2020. The used font has a display bug in older versions. LuaLaTeX is also recommended (but other LaTeX compilers should work as well).

The file me-agency.lco.example in the folder sender must be renamed to me-agency.lco for the build process to work.

Structure

  • sender/ contains the sender's data (i.e. your data) you want to include.
  • receiver/ contains the contact data of the receiver (i.e. the agency).
  • sender.lco contains general settings about how the sender is displayed.
  • ifg-letter-appeal.tex is the main entry point. Use it to generate the letter.

Credits

The letter style is mostly made possible thanks to scrletter/scrlttr2, i.e. the LaTeX KOMA-Script classes.

Also thanks to the awesome Stackexchange Tex community. (Used questions/answers are usually linked as comments.)

Other helpful links

Legal notice

This does not constitute legal advice. The texts used are only examples and should be checked for their application before each use.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

ifg-letter-appeal by rugk is licensed under Creative Commons Attribution 4.0 International (CC-BY).

ifg-letter-appeal's People

Contributors

github-actions[bot] avatar rugk avatar texhackse avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

ifg-letter-appeal's Issues

Remove mail merge feature

The template has initially been built to make mass mailings (mail merge) possible, but this is likely not very useful given you anyway have to write things separately.

Markdown support (with pandoc)

First of all, I really like your template, great work!

I personally like to write my letters in Markdown and use pandoc together with a template to compile them to beautiful, well-formatted PDFs. This is made possible by pandoc's template syntax, which parses data from a markdown file's YAML frontmatter and places it within the document.

As an example, setting the sender's name using pandoc and YAML works as follows:

  1. Replace the sender's name with the sender.name variable in your LaTeX file:
\newcommand{\ownname}{$sender.name$}
  1. Mention a sender.name entry in your markdown's YAML frontmatter:
---
sender:
  name: Vorname Nachname
---

...text...

An entire IFG letter written in Markdown may look like this:

---
sender:
  name: Vorname Nachname
  address:
  - ExampleStreet 42
  - 12345 Stadt
  email: [email protected]
  phone: "+49123456789"
  url: http://test.de
receiver:
  - Informationstechnikzentrum Bund
  - Bernkasteler Straße 8
  - 53175 Bonn
date: 24. April 2021 # defaults to today
place: Stadt
location: Stadt
request:
  title: Informationsanfrage zu Beispieldaten
  number: 123456
  mail: [email protected]
  uploadToken: copytokenforuploadhere
  date: "01. Januar 2021"
  noticeDate: "01. Februar 2021"
  noticeRef: "123456#EXAMPLE#0042"
  docNr: "123456#EXAMPLE#0042#0004"
---

# Sachverhalt

...

# Begründung

...

I have not created a PR yet since I first wanted to ask whether this feature could be incorporated into the project.

Since every variable used needs to be referenced in the LaTeX template, the template gets much more complex and becomes less suitable for manual editing. An example of what this looks like can be found here.

Further limitations of this approach:

  • Only a predefined set of values can be changed. If someone wants to change the structure of the document, they need to do so in the LaTeX template.
  • If the resulting PDF files need to be reproducable, the LaTeX template used needs to be versioned in so far it is subject to change. Since these letters of appeal are meant to be submitted to Frag den Staat, "losing" and therefore having to reproduce a letter is unlikely.
  • If the underlying template is updated and includes breaking changes, old Markdown files may not correctly compile or may not compile at all.

I personally think that writing a little markdown with some frontmatter on top is much more enjoyable and quicker than dealing with seperate LaTeX files for every appeal and the limitations above are fairly manageable.

Do you think it makes sense to incorporate such a feature into this project, or is it out of the project's scope?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.