WIP make site localizable

README.md

@@ -55,6 +55,10 @@ The website "chrome" strings are localized using the standard,
 built-in [Hugo i18n](https://gohugo.io/content-management/multilingual/)
 support.  Those files are in _data/_.
 
+Translation happens by conversion Markdown into _gettext_ using
+[po4a](https://po4a.org).  To generate the _.md_ files from the
+_gettext .po_ files, run:  `po4a po/po4a.conf`.
+
 ## License
 
 The theme used for this website is based on [github-project-landing-page](https://github.com/nsomar/github-project-landing-page) which is licensed under the

site/po/po4a.conf

@@ -0,0 +1,10 @@
+[po4a_langs] en
+[po4a_paths] po/reuse-website.pot $lang:po/reuse-website.$lang.po
+
+[options] opt:"--addendum-charset=UTF-8" opt:"--localized-charset=UTF-8" opt:"--master-charset=UTF-8" opt:"--master-language=en_US" opt:"--msgmerge-opt='--no-wrap'" opt:"--porefs=file" opt:"--wrap-po=newlines"
+
+[po4a_alias:markdown] text opt:"--option markdown" opt:"--option yfm_keys=title" opt:"--addendum-charset=UTF-8" opt:"--localized-charset=UTF-8" opt:"--master-charset=UTF-8" opt:"--keep=100"
+
+[type: markdown] content/comparison.md $lang:$lang/content/comparison.md
+[type: markdown] content/dev.md $lang:$lang/content/dev.md
+[type: markdown] content/materials.md $lang:$lang/content/materials.md

site/po/reuse-website.pot

@@ -0,0 +1,369 @@
+# SOME DESCRIPTIVE TITLE
+# Copyright (C) YEAR Free Software Foundation, Inc.
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"POT-Creation-Date: 2020-04-27 22:41+0200\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"Language: en_US\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+
+#. type: Title ##
+#: content/comparison.md content/materials.md
+#, markdown-text, no-wrap
+msgid "Comparison of license compliance projects"
+msgstr ""
+
+#. type: Plain text
+#: content/comparison.md
+#, markdown-text
+msgid "It is easy to get confused by the multitude of initiatives and tools that help with software license compliance. Provided below is a short and incomplete overview of some noteworthy projects."
+msgstr ""
+
+#. type: Plain text
+#: content/comparison.md
+#, markdown-text
+msgid "REUSE does not intend to replace, but rather complement them. We try to solve unclear and missing license and copyright information at the very source. We empower developers to ensure proper and exhaustive licensing of their project."
+msgstr ""
+
+#. type: Bullet: '* '
+#: content/comparison.md
+#, markdown-text
+msgid "[**SPDX**](https://spdx.org) is the rock upon which REUSE is built. SPDX defines a standardized way to share copyright and licensing information between projects and people. Read more in [our FAQ](/faq/#what-is-spdx)."
+msgstr ""
+
+#. type: Bullet: '* '
+#: content/comparison.md
+#, markdown-text
+msgid "[**ClearlyDefined**](https://clearlydefined.io) collects and displays meta and security information about a large number of projects distributed on different package registries. It also motivates developers and curators to extend data about a project's licensing and copyright situation. REUSE in comparison concentrates on fixing the problem at the file level for individual projects, which in turn will ease ClearlyDefined's efforts."
+msgstr ""
+
+#. type: Bullet: '* '
+#: content/comparison.md
+#, markdown-text
+msgid "[**OpenChain**](https://www.openchainproject.org) focuses on making Free Software license compliance more transparent, predictable, and understandable for participants in the software supply chain. OpenChain recommends REUSE as one component to increase clarity of the licensing and copyright situation, but has higher requirements to achieve full conformance."
+msgstr ""
+
+#. type: Bullet: '* '
+#: content/comparison.md
+#, markdown-text
+msgid "[**FOSSology**](https://www.fossology.org) is a toolkit for Free Software compliance, stores information in a database, and includes license, copyright and export scanners. It is more complex than REUSE and its helper tool and rather optimized for compliance officers and lawyers. REUSE instead intends to have all licensing and copyright information stored in or next to the source files to safeguard this information when reused elsewhere."
+msgstr ""
+
+#. type: YAML Front Matter: title
+#: content/dev.md
+#, no-wrap
+msgid "Help for developers"
+msgstr ""
+
+#. type: Plain text
+#: content/dev.md
+#, markdown-text
+msgid "Licensing should be easy for developers. We provide several tools and services to allow you to concentrate on coding."
+msgstr ""
+
+#. type: Plain text
+#: content/dev.md
+#, markdown-text
+msgid "Contents: [Helper tool](#tool), [example repositories](#repos), [REUSE API](#api), [CI/CD workflows](#ci)"
+msgstr ""
+
+#. type: Title ##
+#: content/dev.md
+#, markdown-text, no-wrap
+msgid "Helper Tool {#tool}"
+msgstr ""
+
+#. type: Plain text
+#: content/dev.md
+#, markdown-text
+msgid "The [REUSE helper tool](https://git.fsfe.org/reuse/tool) assists with achieving and confirming REUSE compliance. It downloads the full license texts, adds copyright and license information to file headers, and contains a linter to identify problems. Eventually, you can generate a software bill of materials."
+msgstr ""
+
+#. type: Plain text
+#: content/dev.md
+#, markdown-text
+msgid "Read the [documentation](https://reuse.readthedocs.io) to learn more about the tool. You will also find a [tool section in our FAQ](/faq/#tool) for the most pressing questions."
+msgstr ""
+
+#. type: Title ##
+#: content/dev.md
+#, markdown-text, no-wrap
+msgid "Example repositories {#repos}"
+msgstr ""
+
+#. type: Plain text
+#: content/dev.md
+#, markdown-text
+msgid "What does a REUSE-compliant project look like? The following repositories are basic, but each of them is REUSE-compliant. We make them available to demonstrate how REUSE works in practice."
+msgstr ""
+
+#. type: Plain text
+#: content/dev.md
+#, markdown-text
+msgid "- [reuse-example](https://git.fsfe.org/reuse/example) - a REUSE compliant repository showing a few methods to add copyright and licensing information. Includes a non-compliant branch for testing. This project is the basis for [our tutorial](/tutorial).  - [reuse-tool](https://git.fsfe.org/reuse/tool) - the helper tool itself is compliant, just like [all other REUSE repositories](https://git.fsfe.org/reuse/)."
+msgstr ""
+
+#. type: Plain text
+#: content/dev.md
+#, markdown-text
+msgid "Consider registering your project with the [REUSE API](#api) to include a dynamic compliance badge."
+msgstr ""
+
+#. type: Title ##
+#: content/dev.md
+#, markdown-text, no-wrap
+msgid "API {#api}"
+msgstr ""
+
+#. type: Plain text
+#: content/dev.md
+#, markdown-text
+msgid "The [REUSE API](https://api.reuse.software) helps you to continuously check and display compliance with the REUSE guidelines. You can include a badge indicating the live status in your README file, and parse the output using the generated JSON file."
+msgstr ""
+
+#. type: Plain text
+#: content/dev.md
+#, markdown-text
+msgid "This is how the badge will look like for a REUSE compliant project. You can click on the badge to see more information: [![REUSE status](https://api.reuse.software/badge/git.fsfe.org/reuse/api)](https://api.reuse.software/info/git.fsfe.org/reuse/api)"
+msgstr ""
+
+#. type: Plain text
+#: content/dev.md
+#, markdown-text
+msgid "The API is the perfect tool for everyone who wants to show that their repository follows best practices in providing licensing and copyright information. It allows third-party services to integrate the live REUSE status, and offers a simple alternative for people who do not want to install the [REUSE helper tool](#tool) for a first quick check."
+msgstr ""
+
+#. type: Plain text
+#: content/dev.md
+#, markdown-text
+msgid "As everything else in REUSE, the API is [publicly available](https://git.fsfe.org/reuse/api) under Free Software licenses."
+msgstr ""
+
+#. type: Title ##
+#: content/dev.md
+#, markdown-text, no-wrap
+msgid "Pre-commit hook {#pre-commit-hook}"
+msgstr ""
+
+#. type: Plain text
+#: content/dev.md
+#, markdown-text
+msgid "You can automatically run `reuse lint` on every commit as a pre-commit hook for Git. This uses [pre-commit](https://pre-commit.com/). Once you [have it installed](https://pre-commit.com/#install), add this to the `.pre-commit-config.yaml` in your repository:"
+msgstr ""
+
+#. type: Fenced code block (yaml)
+#: content/dev.md
+#, no-wrap
+msgid ""
+"repos:\n"
+"-   repo: https://github.com/fsfe/reuse-tool\n"
+"    rev: latest\n"
+"    hooks:\n"
+"    - id: reuse\n"
+msgstr ""
+
+#. type: Plain text
+#: content/dev.md
+#, markdown-text
+msgid "Then run `pre-commit install`. Now, every time you commit, `reuse lint` is run in the background, and will prevent your commit from going through if there was an error."
+msgstr ""
+
+#. type: Title ##
+#: content/dev.md
+#, markdown-text, no-wrap
+msgid "Inclusion in CI/CD workflows {#ci}"
+msgstr ""
+
+#. type: Plain text
+#: content/dev.md
+#, markdown-text
+msgid "REUSE can be easily integrated into your existing CI/CD processes to continuously test your repository and its changes for REUSE compliance."
+msgstr ""
+
+#. type: Plain text
+#: content/dev.md
+#, markdown-text
+msgid "The FSFE offers a Docker image which can be used in numerous CI solutions. Find a few examples below:"
+msgstr ""
+
+#. type: Title ###
+#: content/dev.md
+#, markdown-text, no-wrap
+msgid "Drone"
+msgstr ""
+
+#. type: Plain text
+#: content/dev.md
+#, markdown-text
+msgid "Include the following snippet in your `.drone.yml` file:"
+msgstr ""
+
+#. type: Fenced code block
+#: content/dev.md
+#, no-wrap
+msgid ""
+"pipeline:\n"
+"  reuse:\n"
+"    image: fsfe/reuse:latest\n"
+"    commands:\n"
+"      - reuse lint\n"
+msgstr ""
+
+#. type: Plain text
+#: content/dev.md
+#, markdown-text
+msgid "More information about Drone on [drone.io](https://drone.io)."
+msgstr ""
+
+#. type: Title ###
+#: content/dev.md
+#, markdown-text, no-wrap
+msgid "GitHub"
+msgstr ""
+
+#. type: Plain text
+#: content/dev.md
+#, markdown-text
+msgid "Include the following snippet in your `.github/workflows/*.yml` file:"
+msgstr ""
+
+#. type: Fenced code block
+#: content/dev.md
+#, no-wrap
+msgid ""
+"steps:\n"
+"...\n"
+"- name: Check REUSE compliance\n"
+"        uses: docker://fsfe/reuse\n"
+"        with:\n"
+"          args: reuse lint\n"
+msgstr ""
+
+#. type: Plain text
+#: content/dev.md
+#, markdown-text
+msgid "More information about GitHub Actions on [help.github.com](https://help.github.com/en/actions/automating-your-workflow-with-github-actions)."
+msgstr ""
+
+#. type: Title ###
+#: content/dev.md
+#, markdown-text, no-wrap
+msgid "GitLab"
+msgstr ""
+
+#. type: Plain text
+#: content/dev.md
+#, markdown-text
+msgid "Include the following snippet in your `.gitlab-ci.yml` file:"
+msgstr ""
+
+#. type: Fenced code block
+#: content/dev.md
+#, no-wrap
+msgid ""
+"reuse:\n"
+"  image: fsfe/reuse:latest\n"
+"  script:\n"
+"    - reuse lint\n"
+msgstr ""
+
+#. type: Plain text
+#: content/dev.md
+#, markdown-text
+msgid "More information about GitLab's CI on [docs.gitlab.com](https://docs.gitlab.com/ce/ci/quick_start/)."
+msgstr ""
+
+#. type: Title ###
+#: content/dev.md
+#, markdown-text, no-wrap
+msgid "Travis CI"
+msgstr ""
+
+#. type: Plain text
+#: content/dev.md
+#, markdown-text
+msgid "Include the following snippet in your `.travis.yml` file:"
+msgstr ""
+
+#. type: Fenced code block
+#: content/dev.md
+#, no-wrap
+msgid ""
+"language: minimal\n"
+"\n"
+"services:\n"
+"  - docker\n"
+"\n"
+"before_install:\n"
+"- docker pull fsfe/reuse:latest\n"
+"- docker run -v ${TRAVIS_BUILD_DIR}:/data fsfe/reuse reuse lint\n"
+msgstr ""
+
+#. type: Plain text
+#: content/dev.md
+#, markdown-text
+msgid "More information on Travis CI on [travis-ci.com](https://travis-ci.com)."
+msgstr ""
+
+#. type: YAML Front Matter: title
+#: content/materials.md
+#, no-wrap
+msgid "Materials"
+msgstr ""
+
+#. type: Plain text
+#: content/materials.md
+#, markdown-text
+msgid "Provided here are some further REUSE materials. Feel free to use the material on this page as you see fit. Unless otherwise noted, the material is available under CC-BY-SA-4.0."
+msgstr ""
+
+#. type: Title ##
+#: content/materials.md
+#, markdown-text, no-wrap
+msgid "Get in touch {#contact}"
+msgstr ""
+
+#. type: Plain text
+#: content/materials.md
+#, markdown-text
+msgid "Just like Free Software, the REUSE project is based on its community and the people who support and adopt it. Become part of it by joining the [mailing list](https://lists.fsfe.org/mailman/listinfo/reuse) to get to know other users, and influence the way REUSE evolves."
+msgstr ""
+
+#. type: Plain text
+#: content/materials.md
+#, markdown-text
+msgid "We have compiled a short and incomplete [comparison of REUSE and other projects](/comparison) in the area of Free Software license compliance."
+msgstr ""
+
+#. type: Title ##
+#: content/materials.md
+#, markdown-text, no-wrap
+msgid "Graphical profile"
+msgstr ""
+
+#. type: Plain text
+#: content/materials.md
+#, markdown-text
+msgid "The REUSE logotype in a few different formats is [available in Git](https://git.fsfe.org/reuse/reuse-ci/)."
+msgstr ""
+
+#. type: Title ##
+#: content/materials.md
+#, markdown-text, no-wrap
+msgid "Video"
+msgstr ""
+
+#. type: Plain text
+#: content/materials.md
+#, markdown-text
+msgid "Different versions and file formats of the REUSE video are [available on our download server](https://download.fsfe.org/videos/reuse/)."
+msgstr ""