]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/todo/_Add_ikiwiki_PO-Plugin_to_ignore_languages.mdwn
Update user name
[git.ikiwiki.info.git] / doc / todo / _Add_ikiwiki_PO-Plugin_to_ignore_languages.mdwn
index aecfa68d33e2db0f3714464876e793fd48ce55e8..fbdccc5b2e8d7a71945db391796c3454c43ca43d 100644 (file)
@@ -1,7 +1,37 @@
-[[!tag patch]]
-[[!template  id=gitbranch branch=feature/15355-po-plugin-disable-languages author="[[hefee]]"]]
+[[!template  id=gitbranch branch=feature/15355-po-plugin-disable-languages author="[[intrigeri]]"]]
 
-In order to be able to prepare more translations before publishing them, it is a good a idea to have disabled languages.
-Currently there are some small issues that need to cleanup before able to push this into ikiwiki upstream.
+`po_disabled_languages` is used to disable languages on the website. It
+can be used to prepare new translations, while it will hide those from
+the end-user. More precisely, PO files for these languages are updated
+normally, however, HTML creation will be disabled and no reference to
+these translations will be visible on the website.
 
 See also downstream bug report in tails: <https://labs.riseup.net/code/issues/15355>
+
+> From the downstream bug report it appears this branch is not yet
+> considered ready (as of February 2019), so I haven't attempted to
+> review it.
+>
+> As with everything else in the `po` plugin: I would really want to see
+> some regression test coverage before merging this, because as far as I'm
+> aware none of the ikiwiki maintainers use the `po` plugin, so we are
+> not able to detect regressions other than via the automated tests. That
+> isn't a good situation to be in for a plugin that uses `IkiWiki::inject`
+> to monkey-patch ikiwiki internals. If this plugin is important to you,
+> more test coverage would be very much appreciated.
+> --[[smcv]]
+
+>> I've put this branch into a shape that I now dare submitting:
+>> https://salsa.debian.org/tails-team/ikiwiki/tree/feature/15355-po-plugin-disable-languages.
+>> It adds a little bit test coverage in the form of integration tests
+>> for the proposed feature, that incidentally exercise the rest of the
+>> basic functionality of the PO plugin.
+>> Credits go to hefee for the initial work; I merely did a lot of polishing.
+>> Happy to squash all this into a single commit if you prefer.
+>> --[[intrigeri]]
+
+>>> Please let me know if the added test coverage is sufficient to unblock
+>>> the merge of this branch. Thanks in advance!
+>>> --[[intrigeri]]
+
+[[!tag patch]]