Update 'release' to work with po4a #510

ignotus666 · 2021-06-03T06:43:01Z

Does this need translation?

Yes
[* ] No

Changes

This PR will update 'release' to work with po4a. All wiki .md files are unchanged save for the removed en- prefixes. I built the website locally and everything seems to work properly.

ignotus666 · 2021-06-03T13:53:57Z

I've fixed several anchors in FR and EN, a few typos... I'm going to leave it there. Aside from whatever needs to be updated from now on, I think it's all ship-shape in its current incarnation.

ann0see

Not yet approving since I plan to do a deeper review in future.

ann0see · 2021-06-04T11:44:57Z

README.md


 For translating text in the Jamulus application itself, please see [TRANSLATING.md](https://github.com/jamulussoftware/jamulus/blob/master/TRANSLATING.md)

-We collect changes to the English version of the site on a "changes" branch first. We then freeze changes prior to a Jamulus software release, and do a translation "sprint" over a couple of weeks when all translation takes place.
+We collect changes to the English version of the site on a "next-release" branch first. We then freeze changes prior to a Jamulus software release, and do a translation "sprint" over a couple of weeks when all translation takes place.


This needs renaming of the changes branch --> todo

ann0see · 2021-06-04T11:45:20Z

README.md


 ### Here’s the overall workflow

-1. Changes are first made to en-*.md files and committed to the “changes” branch.
+1. Changes are first made to EN *.md files and committed to the “next-release” branch.


Suggested change

1. Changes are first made to EN *.md files and committed to the “next-release” branch.

1. Changes are first made to EN (= English) *.md files and committed to the “next-release” branch.

ann0see · 2021-06-04T11:46:23Z

README.md

@@ -62,6 +63,8 @@ We collect changes to the English version of the site on a "changes" branch firs

 ## Adding a new language

+First open an issue so that the relevant folders and files can be created for your language in `translator-files/l10n/po/`.


Adding a new language should be documented somewhere else, so that more people know what needs to be done.

Not sure where to add it. Where do you suggest?

Either a separate file or here.

po4a-create-all-targets.sh

ann0see · 2021-06-04T11:55:51Z

po4a-create-all-targets.sh

+####################################
+
+cd ./wiki/
+rm -rf de es fr it pt


Could you use an external config file or even better check which languages exist based on _config.yml? Hardcoding means we need to remember changing this every time a language gets added or deleted.

I had a go at extracting the dir names from PO_DIR to use as a variable in a for loop, as those will be the supported languages, but I couldn't get it to work and don't really want to spend ages figuring it out. Bear in mind that I took most of the content of these scripts from elsewhere and adapted them. It's a miracle I got them to work at all... I have zero experience writing scripts beyond making simple app launchers for my desktop.

Success. Might be hacky but it works.

po4a-create-all-targets.sh

ann0see

Thanks again! Once I have more time, I'll do a deeper review; but from a first glance I'd like to have more comments (for each language: delete folders or check if directory exists/run po4a to generate md files for jekyll,...)

ann0see · 2021-06-05T07:33:32Z

Merged; however it still needs some more work probably.

ann0see · 2021-06-06T13:41:06Z

po4a-update-templates.sh

+    path="${dirname#$SRCDIR_MODULE/}"
+
+    if [ "$dirname" = "$SRCDIR_MODULE" ]; then
+        potname=$basename.pot


@ignotus666 I'm a bit worried about quoting here. If $basename includes spaces it might break.

ann0see · 2021-06-06T13:41:14Z

po4a-update-templates.sh

+    if [ "$dirname" = "$SRCDIR_MODULE" ]; then
+        potname=$basename.pot
+    else
+        potname=$path/$basename.pot


ann0see · 2021-06-06T13:41:56Z

po4a-create-all-targets.sh

+# SRCDIR root of the documentation repository
+# PODIR place where to create the po
+# PUB_DIR place where to publish the localised files


You should put this directly at the lines where you define these variables

This has been done in a previous PR. You seem to be checking the version in "next-release". The one in "release" has those comments in place.

Hmm. Ok. Sorry about that. I reviewed this (merged) PR which didn't include the latest changes you did.

ann0see · 2021-06-06T13:42:24Z

po4a-create-all-targets.sh

+do
+	lang=$(basename -s .md "$dir")
+	echo "delete $lang folder"
+    cd ./wiki/


Any reason for this indentation?

The indentation seems correct if I open it as a text file locally... I'll have a look.

ann0see · 2021-06-06T13:44:43Z

po4a-create-all-targets.sh

+
+# Check if po4a is installed
+if ! [ -x "$(command -v po4a)" ] ; then
+    echo 'Error: please install po4a.' >&2


Consistency: please use double quotes here too.

ann0see · 2021-06-06T13:45:58Z

po4a-create-all-targets.sh

+	do
+		basename="$(basename -s .md "$file")"
+		dirname=$(dirname "$file")
+		path="${dirname#$SRCDIR_MODULE/}"


Not totally sure what this one does here. Could you please explain? # seems to count how long a variable is?

I think it takes the variable 'dirname' and assigns what's after SRCDIR_MODULE (this variable name has changed in the new version) to it. I'm not sure though... those lines were pilfered from elsewhere...

ann0see · 2021-06-06T13:46:30Z

po4a-update-templates.sh

+# SRCDIR root of the documentation repository
+# POTDIR place where to create the .pot templates


Same as in po4a-create-all-targets.sh

ann0see · 2021-06-06T13:46:56Z

po4a-update-templates.sh

+
+# Check if po4a is installed
+if ! [ -x "$(command -v po4a)" ] ; then
+    echo 'Error: please install po4a.' >&2


ann0see · 2021-06-06T13:47:43Z

po4a-update-templates.sh

+        po_file="$PO_DIR/$lang/${potname%.pot}.po"
+
+        # po4a-updatepo would be angry otherwise
+        sed -i 's/Content-Type: text\/plain; charset=CHARSET/Content-Type: text\/plain; charset=UTF-8/g' "$po_file"


Probably a bit hacky, but seems to work.

ignotus666

If you have more comments go ahead - I'll make PR tonight. No time now.

ann0see · 2021-06-06T14:15:15Z

No problem;-)

ignotus666 added 8 commits June 3, 2021 08:18

Update Release branch to use po4a

2168bc2

Corrections

10b33c7

Correction

35e5823

Update README

006bed5

Update README

eb82176

Update translators' README

90d7543

Update translators' README

7e53d00

Fix anchor link in Server-Linux.md

23dbf32

ignotus666 mentioned this pull request Jun 3, 2021

Anchor link at Server-Linux page not correct #508

Closed

ignotus666 added 5 commits June 3, 2021 11:56

Fix same anchor in fr

29658b6

Fixed more anchors in EN, FR

a0f7da1

typo

b20c921

Fix typos and anchors

a4156bc

Correction

a99700a

ignotus666 added 3 commits June 3, 2021 16:50

Update translator README

5ff8124

Update OmegaT guide

08ca875

Update wiki README

79da413

ann0see requested review from ann0see and jujudusud June 4, 2021 11:44

ann0see reviewed Jun 4, 2021

View reviewed changes

ignotus666 added 3 commits June 4, 2021 16:28

Updates to README and scripts

26d2d89

Updated wiki/README

b70a163

Update script

8943b2e

ann0see reviewed Jun 4, 2021

View reviewed changes

ann0see linked an issue Jun 4, 2021 that may be closed by this pull request

Create po4a branch for changes/corrections to EN and translations #509

Closed

jujudusud approved these changes Jun 5, 2021

View reviewed changes

ann0see merged commit 3cf2089 into jamulussoftware:release Jun 5, 2021

ann0see reviewed Jun 6, 2021

View reviewed changes

ignotus666 commented Jun 6, 2021

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update 'release' to work with po4a #510

Update 'release' to work with po4a #510

ignotus666 commented Jun 3, 2021

ignotus666 commented Jun 3, 2021

ann0see left a comment

ann0see Jun 4, 2021

ann0see Jun 4, 2021

ignotus666 Jun 4, 2021

ann0see Jun 4, 2021

ignotus666 Jun 4, 2021

ann0see Jun 4, 2021

ann0see Jun 4, 2021

ignotus666 Jun 4, 2021 •

edited

Loading

ignotus666 Jun 4, 2021

ann0see left a comment

ann0see commented Jun 5, 2021

ann0see Jun 6, 2021

ignotus666 Jun 6, 2021

ann0see Jun 6, 2021

ignotus666 Jun 6, 2021

ann0see Jun 6, 2021

ignotus666 Jun 6, 2021

ann0see Jun 6, 2021

ann0see Jun 6, 2021

ignotus666 Jun 6, 2021

ann0see Jun 6, 2021

ignotus666 Jun 6, 2021

ann0see Jun 6, 2021

ignotus666 Jun 6, 2021

ann0see Jun 6, 2021

ann0see Jun 6, 2021

ignotus666 Jun 6, 2021

ann0see Jun 6, 2021

ignotus666 left a comment

ann0see commented Jun 6, 2021

	1. Changes are first made to EN *.md files and committed to the “next-release” branch.
	1. Changes are first made to EN (= English) *.md files and committed to the “next-release” branch.

		@@ -62,6 +63,8 @@ We collect changes to the English version of the site on a "changes" branch firs

		## Adding a new language

		First open an issue so that the relevant folders and files can be created for your language in `translator-files/l10n/po/`.

		# SRCDIR root of the documentation repository
		# POTDIR place where to create the .pot templates

Update 'release' to work with po4a #510

Update 'release' to work with po4a #510

Conversation

ignotus666 commented Jun 3, 2021

Does this need translation?

Changes

ignotus666 commented Jun 3, 2021

ann0see left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ignotus666 Jun 4, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ann0see left a comment

Choose a reason for hiding this comment

ann0see commented Jun 5, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ignotus666 left a comment

Choose a reason for hiding this comment

ann0see commented Jun 6, 2021

ignotus666 Jun 4, 2021 •

edited

Loading