From 003ba4a9b3234d980ebe2bf443e0435f59bf3c27 Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Tue, 23 Oct 2007 16:52:02 +0200 Subject: Add brief documentation. --- README | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 README (limited to 'README') diff --git a/README b/README new file mode 100644 index 0000000..92820c0 --- /dev/null +++ b/README @@ -0,0 +1,33 @@ +Ikiwiki w/ translations +======================= + +Ikiwiki[1] is a perl-based wiki compiler. + +This is routines to manage translatable parts of Ikiwiki and translations into +the following locales: + + * danish (da) by Jonas Smedegaard + + +Installation +------------ + +To pull in all translatable and translated parts, do this: + + make + +To remove all translatable and translated parts, and anything else below those +directories without warning, do this: + + make ultraclean + +Source +------ + +These routines are available at http://source.jones.dk/ as a GIT archive - like +this: + + git clone http://source.jones.dk/ikiwiki.git + + +[1] http://ikiwiki.info/ -- cgit v1.2.3 From d6cddc84f5e916c468bf54f9519b2617b6676afc Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Tue, 23 Oct 2007 18:28:57 +0200 Subject: More documentation, --- README | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) (limited to 'README') diff --git a/README b/README index 92820c0..f94aedc 100644 --- a/README +++ b/README @@ -24,10 +24,30 @@ directories without warning, do this: Source ------ -These routines are available at http://source.jones.dk/ as a GIT archive - like -this: +These routines are available at http://source.jones.dk/ as a GIT repository. +Pull it like this: git clone http://source.jones.dk/ikiwiki.git +To publish your own forked repository through web, you need to create a special +public repository that you "push" your changes into from your private working +repository (the --all option is rewuired only initially) - like this: + + GIT_DIR=public_dir/repository_name.git git --bare init --shared + chmod +x public_dir/repository_name.git/hooks/post-update + git push --all + +To resyncronize an older fork of the repository, re-applying local changes on +top of the newer upstream GIT source, do like this from within your local +forked repository: + + git remote add ikiwiki http://source.jones.dk/ikiwiki.git + git fetch ikiwiki + git rebase ikiwiki/master + + +---- + +References: [1] http://ikiwiki.info/ -- cgit v1.2.3 From ae68052e87dad54b16a9878f98dd9a2207bb9cb1 Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Tue, 23 Oct 2007 18:51:54 +0200 Subject: More details on creating public repository. --- README | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) (limited to 'README') diff --git a/README b/README index f94aedc..0ae879c 100644 --- a/README +++ b/README @@ -29,12 +29,18 @@ Pull it like this: git clone http://source.jones.dk/ikiwiki.git -To publish your own forked repository through web, you need to create a special -public repository that you "push" your changes into from your private working -repository (the --all option is rewuired only initially) - like this: +To publish your own forked repository through web, you first need to create a +special public repository that you "push" your changes into from your private +working repository - like this: GIT_DIR=public_dir/repository_name.git git --bare init --shared chmod +x public_dir/repository_name.git/hooks/post-update + +To actually use your newly created public repository as above, you first need +to populate it with your current working repository (the --all option is only +this once, not on subsequent pushes) - like this: + + git remote add origin git-reference-to-public-repository git push --all To resyncronize an older fork of the repository, re-applying local changes on -- cgit v1.2.3 From 90ac3ddb96fa6516388bc5f6f04a4acd228d28e0 Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Sun, 28 Oct 2007 18:40:12 +0100 Subject: Forking development requires changing (not adding) the origin. --- README | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'README') diff --git a/README b/README index 0ae879c..963cb1e 100644 --- a/README +++ b/README @@ -36,11 +36,11 @@ working repository - like this: GIT_DIR=public_dir/repository_name.git git --bare init --shared chmod +x public_dir/repository_name.git/hooks/post-update -To actually use your newly created public repository as above, you first need -to populate it with your current working repository (the --all option is only -this once, not on subsequent pushes) - like this: +To actually use your newly created public repository created above, you need to +populate it with your current working repository (the --all option is only this +once, not on subsequent pushes) - like this: - git remote add origin git-reference-to-public-repository + git config remote.origin.url git-reference-to-public-repository git push --all To resyncronize an older fork of the repository, re-applying local changes on -- cgit v1.2.3 From 6fa3064fb5115e91cce64ab56c0b3b5c14b8b368 Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Fri, 2 Nov 2007 12:56:43 +0100 Subject: Document overriding repository setting for write access. --- README | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'README') diff --git a/README b/README index 963cb1e..289b52d 100644 --- a/README +++ b/README @@ -16,6 +16,10 @@ To pull in all translatable and translated parts, do this: make +To pull in all parts with write access to the repository, do this: + + make origin_ikiwiki='login@example.com:path/to/repositories/ikiwiki_$(underlay).git' + To remove all translatable and translated parts, and anything else below those directories without warning, do this: -- cgit v1.2.3 From 505e184a4a08a935f1f2bfb0bb9e7db3cd8b1ff8 Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Fri, 2 Nov 2007 14:26:54 +0100 Subject: Replace unneeded and problematic git rebase with git pull (now that I have figured out how to pull from third party). --- README | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) (limited to 'README') diff --git a/README b/README index 289b52d..5280f86 100644 --- a/README +++ b/README @@ -47,13 +47,11 @@ once, not on subsequent pushes) - like this: git config remote.origin.url git-reference-to-public-repository git push --all -To resyncronize an older fork of the repository, re-applying local changes on -top of the newer upstream GIT source, do like this from within your local -forked repository: +To resyncronize an older fork of the repository with newer upstream changes, do +like this (skip first command on subsequent updates): git remote add ikiwiki http://source.jones.dk/ikiwiki.git - git fetch ikiwiki - git rebase ikiwiki/master + git pull ikiwiki master ---- -- cgit v1.2.3 From e175511e4792242de9346a34af5379f404a13236 Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Fri, 2 Nov 2007 18:06:36 +0100 Subject: Add to README a separate section about installation, and rename the old as customization. --- README | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) (limited to 'README') diff --git a/README b/README index 5280f86..43dffa1 100644 --- a/README +++ b/README @@ -9,6 +9,15 @@ the following locales: * danish (da) by Jonas Smedegaard +Getting the source +------------------ + +This README file and related scripts are available at http://source.jones.dk/ +as a GIT repository. Pull it like this: + + git clone http://source.jones.dk/ikiwiki.git + + Installation ------------ @@ -25,13 +34,9 @@ directories without warning, do this: make ultraclean -Source ------- - -These routines are available at http://source.jones.dk/ as a GIT repository. -Pull it like this: - git clone http://source.jones.dk/ikiwiki.git +Customizing +----------- To publish your own forked repository through web, you first need to create a special public repository that you "push" your changes into from your private -- cgit v1.2.3 From 4b43f104988f6fdff8ddee2b13ce2ba066443559 Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Tue, 6 Nov 2007 13:56:20 +0100 Subject: Update documentation: Adjust make command for overriding GIT source. Add section on translation. --- README | 40 ++++++++++++++++++++++++++++++++++++++-- 1 file changed, 38 insertions(+), 2 deletions(-) (limited to 'README') diff --git a/README b/README index 43dffa1..3aa53f2 100644 --- a/README +++ b/README @@ -25,9 +25,10 @@ To pull in all translatable and translated parts, do this: make -To pull in all parts with write access to the repository, do this: +To pull in all parts with write access to the repository, do something like +this: - make origin_ikiwiki='login@example.com:path/to/repositories/ikiwiki_$(underlay).git' + make origin_ikiwiki='login@example.com:path/to/repositories/ikiwiki_MODULE.git' To remove all translatable and translated parts, and anything else below those directories without warning, do this: @@ -59,6 +60,41 @@ like this (skip first command on subsequent updates): git pull ikiwiki master +Translation +----------- + +Some modules (markdown files - template files are not yet supported by po4a) is +translatable through the gettext system using PO files. + +To update PO templates for all modules marked as supporting gettext, do this: + + make pot + +To update PO files for all supported locales of all supported modules, do this: + + make po + +To update all gettext-supported modules based on newer PO files, do this: + + make translations + +To initialize new locales, do like this (all on one line): + + make po po-init-modules="module1 module2" po-init-locales="da sv no" + +If you want to initialize based on an existing locale rather than the master, +add the origin locale to the above make command similar to this: + + make po [...] po-init-fromlocale=de + +To add new modules and locales as gettext supported, add them to *_POMODULES +and *_POLOCALES. Keep them alse in *_MODULES and *_LOCALES to support pulling +final translations without recreating from PO files. + +Please beware that the automated po4a process is not perfected yet, so check +the result before use. + + ---- References: -- cgit v1.2.3 From 0b26a19f2ae304d9710e00ac6d1c6c508f2a8787 Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Fri, 9 Nov 2007 21:37:21 +0100 Subject: Better text about upstream GIT locations, including real example for write access. --- README | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'README') diff --git a/README b/README index 3aa53f2..627b8d1 100644 --- a/README +++ b/README @@ -12,8 +12,8 @@ the following locales: Getting the source ------------------ -This README file and related scripts are available at http://source.jones.dk/ -as a GIT repository. Pull it like this: +This README file is available at http://source.jones.dk/ together with a GIT +repository with source of the translation routines. Pull it like this: git clone http://source.jones.dk/ikiwiki.git @@ -25,10 +25,10 @@ To pull in all translatable and translated parts, do this: make -To pull in all parts with write access to the repository, do something like -this: +If you have write access to one or more GIT repositories, you can override +their locations like this: - make origin_ikiwiki='login@example.com:path/to/repositories/ikiwiki_MODULE.git' + make origin_ikiwiki=debian@source.jones.dk:/srv/git/source.jones.dk/ikiwiki_MODULE.git To remove all translatable and translated parts, and anything else below those directories without warning, do this: -- cgit v1.2.3 From 31e1796579331a8fa6c5bbfb8e307bc35d79792d Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Fri, 9 Nov 2007 21:42:09 +0100 Subject: Fix text about write access to upstream GIT to use new variable scheme. --- README | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README') diff --git a/README b/README index 627b8d1..c010624 100644 --- a/README +++ b/README @@ -28,7 +28,7 @@ To pull in all translatable and translated parts, do this: If you have write access to one or more GIT repositories, you can override their locations like this: - make origin_ikiwiki=debian@source.jones.dk:/srv/git/source.jones.dk/ikiwiki_MODULE.git + make ikiwiki_ORIGIN=debian@source.jones.dk:/srv/git/source.jones.dk/ikiwiki_MODULE.git To remove all translatable and translated parts, and anything else below those directories without warning, do this: -- cgit v1.2.3 From 6517ad6ab9ff4dbbe0486b4af1c6bf3518f2e48b Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Fri, 22 Feb 2008 14:42:20 +0100 Subject: Use native git protocol (yeah - I finally made it work). --- README | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README') diff --git a/README b/README index c010624..4050872 100644 --- a/README +++ b/README @@ -15,7 +15,7 @@ Getting the source This README file is available at http://source.jones.dk/ together with a GIT repository with source of the translation routines. Pull it like this: - git clone http://source.jones.dk/ikiwiki.git + git clone git://source.jones.dk/ikiwiki Installation @@ -56,7 +56,7 @@ once, not on subsequent pushes) - like this: To resyncronize an older fork of the repository with newer upstream changes, do like this (skip first command on subsequent updates): - git remote add ikiwiki http://source.jones.dk/ikiwiki.git + git remote add ikiwiki git://source.jones.dk/ikiwiki git pull ikiwiki master -- cgit v1.2.3 From ba721853a6f276019eb7f8c5b4a31d3c11a7f836 Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Mon, 25 Feb 2008 16:28:25 +0100 Subject: Add notes on forking a multi-branched repository. --- README | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'README') diff --git a/README b/README index 4050872..3becd90 100644 --- a/README +++ b/README @@ -53,6 +53,16 @@ once, not on subsequent pushes) - like this: git config remote.origin.url git-reference-to-public-repository git push --all +To instead populate your newly created public repository with a multi-branched +local repository, first make a complete clone with all branches setup locally, +and push it all - like this for repository with master and master-da branches: + + git clone git-reference-to-old-public-repository some-temp-dir + cd some-temp-dir + git checkout -b master-da origin/master-da + git config remote.origin.url git-reference-to-public-repository + git push --all + To resyncronize an older fork of the repository with newer upstream changes, do like this (skip first command on subsequent updates): -- cgit v1.2.3