Comment on another possible solution to the use case.

[git.ikiwiki.info.git] / doc / plugins / po.mdwn

diff --git a/doc/plugins/po.mdwn b/doc/plugins/po.mdwn
index 8e87e26385babb9622991276f6297e8a96c1f3af..dca2f5d6668615c29b8a4b3fae046b23d0d6ca27 100644 (file)
--- a/doc/plugins/po.mdwn
+++ b/doc/plugins/po.mdwn
@@ -114,7 +114,8 @@ Apache
 
 Using Apache `mod_negotiation` makes it really easy to have Apache
 serve any page in the client's preferred language, if available.
 
 Using Apache `mod_negotiation` makes it really easy to have Apache
 serve any page in the client's preferred language, if available.

-This is the default Debian Apache configuration.
+
+Add 'Options MultiViews' to the wiki directory's configuration in Apache.

 
 When `usedirs` is enabled, one has to set `DirectoryIndex index` for
 the wiki context.
 
 When `usedirs` is enabled, one has to set `DirectoryIndex index` for
 the wiki context.


@@ -123,6 +124,8 @@ Setting `DefaultLanguage LL` (replace `LL` with your default MIME
 language code) for the wiki context can help to ensure
 `bla/page/index.en.html` is served as `Content-Language: LL`.
 
 language code) for the wiki context can help to ensure
 `bla/page/index.en.html` is served as `Content-Language: LL`.
 

+For details, see [Apache's documentation](http://httpd.apache.org/docs/2.2/content-negotiation.html).
+

 lighttpd
 --------
 
 lighttpd
 --------
 


@@ -248,8 +251,16 @@ ea753782b222bf4ba2fb4683b6363afdd9055b64, which should be reverted
 once [[intrigeri]]'s `meta` branch is merged.
 
 An integration branch, called `meta-po`, merges [[intrigeri]]'s `po`
 once [[intrigeri]]'s `meta` branch is merged.
 
 An integration branch, called `meta-po`, merges [[intrigeri]]'s `po`

-and `meta` branches, and thus has thise additional features.
+and `meta` branches, and thus has this additional features.

 
 

+Self links
+----------
+
+If a page contains a WikiLink to itself, ikiwiki does not normally
+turn that into a hyperlink. However, if a translated page contains a
+WikiLink to itself, a hyperlink is inserted, at least with the default
+`po_link_to` the link points to the English version of the page. Is there a
+good reason for that to be done? --[[Joey]] 

 
 Language display order
 ----------------------
 
 Language display order
 ----------------------


@@ -260,47 +271,76 @@ order, as `po_slave_languages` is a hash. It would need to be converted
 to an array to support this. (If twere done, twere best done quickly.)
 --[[Joey]] 
 
 to an array to support this. (If twere done, twere best done quickly.)
 --[[Joey]] 
 

-po files in underlay
---------------------
+Duplicate %links ?
+------------------

 
 

-I think this plugin doesn't yet allow po files to be present in an
-underlay to translate files also from the underlay.
+I notice code in the scan hook that seems to assume
+that %links will accumulate duplicate links for a page.
+That used to be so, but the bug was fixed. Does this mean
+that po might be replacing the only link on a page, in error? 
+--[[Joey]] 

 
 

-In `istranslatablefile`, it specifically checks that
-the file is present in srcdir. 
+Name of toplevel index page
+---------------------------

 
 

-Problem with this is that it precludes using po to translate
-the basewiki (work which is well under way for Danish BTW),
-since the translated po files cannot really be used.
+Normally at the top index page of a wiki, you see the wiki name at
+the top. However, at the top *translated* index page, you see something
+like "index.da". --[[Joey]] 

 
 

-A further problem comes if one wants to use a non-English language as the
-`po_master_language`. It would be good to get a translated
-basewiki, taking po files from the underlay and using them as the primary
-page sources, but this plugin doesn't yet support that. 
+Pagespecs
+---------

 
 

-And, maybe it shouldn't? A user would not expect to see a po file when
-editing the index page of their wiki, just because they're using a
-different language. Instead, we might want to build localized .mdwn files
-for the basewiki, and then ikiwiki would just use that translated underlay.
-The when the user edits index, they get a nice mdwn file to start from.
+I was suprised that, when using the map directive, a pagespec of "*"
+listed all the translated pages as well as regular pages. That can 
+make a big difference to an existing wiki when po is turned on,
+and seems generally not wanted.
+(OTOH, you do want to match translated pages by
+default when locking pages.) --[[Joey]]

 
 

-So, we seem to have two cases, in one po files from the underlay should be
-used, in the other not. Hmm. Support both?
+Edit links on untranslated pages
+--------------------------------

 
 

-> Update -- I've written po2wiki, which can spit out translated underlays
-> in markdown format, and made the po plugin enable use of such underlays
-> when the master language is not `en`.
---[[Joey]] 
+If a page is not translated yet, the "translated" version of it
+displays wikilinks to other, existing (but not yet translated?)
+pages as edit links, as if those pages do not exist. 

 
 

-Duplicate %links ?
-------------------
+That's really confusing, especially as clicking such a link
+brings up an edit form to create a new, english page.

 
 

-I notice code in the scan hook that seems to assume
-that %links will accumulate duplicate links for a page.
-That used to be so, but the bug was fixed. Does this mean
-that po might be replacing the only link on a page, in error? 
+This is with po_link_to=current or negotiated. With default, it doesn't
+happen.. 
+
+Also, this may only happen if the page being linked to is coming from an
+underlay, and the underlays lack translation to a given language.

 --[[Joey]] 
 
 --[[Joey]] 
 

+recentchanges links to po files
+-------------------------------
+
+When a po file is changed, the recentchanges page shows a link such as
+"sandbox.es". But, clicking on it goes to the English (or negotiated
+language) version of the page. It would be better in this one case if
+the link went direct to the translated version of the page. --[[Joey]] 
+
+Double commits of po files
+--------------------------
+
+When adding a new english page, the po files are created, committed,
+and then committed again. The second commit makes this change:
+
+       -"Content-Type: text/plain; charset=utf-8\n"
+       -"Content-Transfer-Encoding: ENCODING"
+       +"Content-Type: text/plain; charset=UTF-8\n"
+       +"Content-Transfer-Encoding: ENCODING\n"
+
+Same thing happens when a change to an existing page triggers a po file
+update. --[[Joey]] 
+
+Ugly messages with empty files
+------------------------------
+
+If there are empty .mdwn files, the po plugin displays some ugly messages.
+

 Documentation
 -------------
 
 Documentation
 -------------