aboutsummaryrefslogtreecommitdiff
path: root/doc (unfollow)
Commit message (Collapse)AuthorFilesLines
2022-01-16Replace left-over usage of git.euandreh.xyzEuAndreh4-4/+4
2022-01-15Update translationsEuAndreh3-3/+3
2022-01-15doc/manpages.sh: Quote variables inside variable expansion (ShellCheck offense)EuAndreh1-3/+3
2021-10-11Replace git.euandreh.xyz/xxx with euandreh.xyz/xxx.gitEuAndreh4-8/+8
2021-10-03TODOs.md: Rename ids to #td-... over #(task|bug|...)-...EuAndreh4-10/+10
The goal is to make a TODO entry be able to move category, say from a question to a decision, without chaging its id.
2021-09-20Enable darkmode for ci.html and manpages HTMLEuAndreh1-1/+9
2021-08-06mv aux/workflow/manpages.sh doc/manpages.shEuAndreh1-0/+68
2021-07-15Add trailing /en/ to all default URLs, and the equivalent for translationsEuAndreh4-4/+4
2021-07-08git mv doc/spelling/ po/EuAndreh5-149/+0
2021-07-07Put pofiles under po/, use one folder for each translated file.EuAndreh3-1526/+0
This is an improvement over 67f7c956239a7bc811a1d655d389666048e45fc3, and a final step for #task-7c5cd2aa-6d92-0423-bfa7-81f2e8436586. Now instead of trying to convince po4a and mdpo to work together, each tools gets it own folder and a pofile for each language. This means that if I want to translate files FOO.md and a-dir/BAR.txt to pt and fr, the directory structure of po/ will be: po/ FOO.md/ pt.po fr.po a-dir/ BAR.txt/ pt.po fr.po The po/ folder mirrors the directory structure of the input files, also nesting down directories. This way mdpo can do extration and update on its own way, and po4a can do extraction and update on its on way. The downside is that some translations will be duplicated, because they can appear on more than one file.
2021-06-26TODOs.md: spellcheckEuAndreh1-2/+4
2021-06-25git mv po/ doc/po/EuAndreh3-0/+1526
2021-06-25aux/workflow/assert-spelling.sh: Add; init dictionaries; fix spellingEuAndreh8-22/+169
- aux/workflow/l10n.sh: fix handling of $@; - Makefile: remove circular dependency between dev-check and public by adding the "l10n-gen" target.
2021-06-23aux/workflow/manpages.sh: Refactor how manpages and translations are madeEuAndreh4-0/+0
I didn't like the previous version of aux/workflow/manpages.sh mainly for 2 reasons: 1. its CLI was terrible, ugly and fragile; 2. it mixed handling manpages and handling *translations*. The first step was to split the translations part to a different file: aux/workflow/l10n.sh. Now it has the base logic for running po4a, and can apply it to manpages. It is useful for updating translated files in other scenarios, such as catgets() message catalogs, markdown files, etc. After I used the venerable getopts to handle the command line arguments, and give aux/workflow/manpages.sh a saner interface. I disliked the fact that aux/workflow/manpages.sh still is being used for the "install" and "uninstall" targets. Before this file, the canonical workflow of "make && make install/uninstall" was 100% embedded within the Makefile itself. But now the Makefile calls to an external script for that. This isn't a real cost, other than how obvious the behaviour is for someone looking at the Makefile for the first time. I still chose to do it anyway, because there was already too many things in the Makefile itself, and it was getting worse with time. I made sure to never cross the line of relying on an external tool for the canonical "make && make install/uninstall", and even for "make check". Those all work without requiring any extra tool outside what POSIX defines, such as "sed", "awk", etc. Despite the cost of adding this detour from the liner Makefile flow, I found it to be worth it to call to the external script, as this script can now also be shared across projects, and the customized Makefile be made simpler. In other to remove the "-- $(do_subst)" horrendous hack, I chose to use an inference rule for ".in" files, and remove the "$(do_subst)" variable altogether. Now all the files that need to go through sed should end in ".in", and the Makefile will take care of producing it. The upside is that this model is much better integrater into make itself. Addresses #task-9ee2bbc8-295f-52b7-4104-483869bad017.
2021-06-23git mv doc/*.po po/EuAndreh3-1526/+0
2021-06-22doc/: s/SYNOPSYS/SYNOPSIS/EuAndreh4-10/+10
2021-06-22Add small example of using -- on manpageEuAndreh7-62/+135
2021-06-21doc/git-permalink.*.1: Mark SUPPORTED REMOTES and OVERRIDES as .SSEuAndreh7-520/+542
Make SUPPORTED REMOTES and OVERRIDES subsections (.SS) of a new parent section: CONFIGURATIONS. Also put SUPPORTED REMOTES before OVERRIDES on the order.
2021-06-21doc/git-permalink.*.1: Mark OPTIONS as to be replacedEuAndreh7-16/+16
Also improve french translation: s/FICHIERS/FICHIER/.
2021-06-21doc/git-permalink.*.1: Add `EXIT STATUS` section; mention `STDOUT` in `-p` ↵EuAndreh7-56/+256
option
2021-06-20doc/pt.po: Fix typo s/OPÇÔES/OPÇÕES/EuAndreh2-3/+3
2021-06-19doc/: Add new supported forges to the manpagesEuAndreh7-75/+196
2021-06-19Leverage po4a to translate manpagesEuAndreh7-9/+1783
2021-06-16doc/git-permalink.1: Add period at the end of NAMEEuAndreh1-1/+1
2021-06-16aux/workflow/assert-manpages.sh: Fix link to mailing listEuAndreh1-1/+1
2021-06-16Show -h and -V flags on usage textEuAndreh1-1/+1
2021-06-16s/Home page/Homepage/EuAndreh1-1/+1
2021-06-16doc/git-permalink.1: Stop using ".P", use empty lines insteadEuAndreh1-82/+78
2021-06-14doc/git-permalink.1: Fix links at the bottomEuAndreh1-10/+12
2021-06-12doc/git-permalink.1: Write initial versionEuAndreh1-0/+157
2021-06-12doc/git-permalink.1: Add empty fileEuAndreh1-0/+0