[Done] Moving documentation into a wiki

Discussion on adblockplus.org website and translations
Wladimir Palant

Re: Moving documentation into a wiki

Post by Wladimir Palant »

Yes, Anwiki has only one main developer and I already filed a few minor bugs (two of them with patches, fixing things there is really simple). So far he has been very responsive. I installed Anwiki under anwiki/ - so far I only added the main page and the installation page in English and German, for testing. Translating is very simple, as a translator you don't need to worry about page markup, you simply translate the text. Links automatically detect untranslated pages and fall back to English. If I update the English page untranslated strings pop up in other language variants immediately, no additional effort required on my part. All in all, perfect for what we need here.

You won't be able to log in yet, I need to create an add-on to reuse phpBB authentication (the existing add-on disables phpBB registration in favor of Anwiki registration, here it should be the other way round).
alberto
Posts: 65
Joined: Sun Jul 12, 2009 10:58 am

Re: Moving documentation into a wiki

Post by alberto »

So far it looks very good indeed

The filter subscription page may present some challenges. Are you still able to refresh this page automatically with the repository? Would Anwiki support auto sync for complex tables? or are you planning to have this list dynamically generated (which could then show first most relevant filters for that language)?
Wladimir Palant

Re: Moving documentation into a wiki

Post by Wladimir Palant »

The filter subscription list is already being generated as HTML code from the repository and inserted into the page via Textpattern plugin. Writing an Anwiki hook doing the same thing won't be a big deal. en/preferences and en/nsIAdblockPlus will be more problematic - if I want to do it properly I should create new content classes for these pages, that's a fair amount of code then.
alberto
Posts: 65
Joined: Sun Jul 12, 2009 10:58 am

Re: Moving documentation into a wiki

Post by alberto »

I was wondering how one go about importing into Anwiki the documentation already translated in few languages.
Is it as simple as copy/paste the content of each language? Will Anwiki automatically align translations line by line (assuming the content structure between language versions is the same)?
In your case, I suppose the English version is most up to date and to be imported last, so any additional bits are automatically included (untranslated) to the French and German versions.
Wladimir Palant

Re: Moving documentation into a wiki

Post by Wladimir Palant »

If you do it manually you will get into trouble, editing the source in French replaces the English version (tried it). Fortunately, I don't plan to do it manually. From the look of it, I can simply import the HTML code into the database tables. I will probably have to verify first that the structure is identical for all languages (I know that for some pages it isn't).

PS: All my Anwiki bug reports have been resolved, nice. One feature request (allow some of the links to be translated) is still open, it is a non-trivial one. But I think I have a work-around that we can use for now.
alberto
Posts: 65
Joined: Sun Jul 12, 2009 10:58 am

Re: Moving documentation into a wiki

Post by alberto »

If you import the HTML directly into the database may work first time, but I think you will have a risk going forward. Because you would had by passed the auto sync functionality, you cannot guarantee that Anwiki understands / aligns correctly the content structure between different language versions. For example, a subsequent update in English may result in an incorrect deletion / update of sections in French / German.

I thought you could align content structure and then edit (i.e. manually copy/paste full page) one by one the content of each language, may be with English last just in case. The Anwiki user guide seems to imply that only additional text (and deletions) are propagated when editing e.g. http://doc.anwiki.com/en/user-guide/autosync#t2 , step 13:20

Looks like this is one for the Anwiki's author to advice!
Wladimir Palant

Re: Moving documentation into a wiki

Post by Wladimir Palant »

Anwiki's author pointed out the import feature - you can give the Wiki an XML file and all pages from it will be imported automatically. I'm not sure whether it checks the structure on import but if I make sure that the structure is identical for all translations there shouldn't be any problems.
Wladimir Palant

Re: Moving documentation into a wiki

Post by Wladimir Palant »

By now about 2/3 of the pages are imported into Anwiki. Rest is failing because of "content desynchronization". Most of the failing pages use custom tags, these need to be converted anyway.
Oxwil
Posts: 28
Joined: Wed Jul 08, 2009 3:24 pm
Location: Emirates Living, Dubai, United Arab Emirates, Earth, Solar System, Milky Way, Universe
Contact:

Re: Moving documentation into a wiki

Post by Oxwil »

Why don't we have volunteers who've been around for quite a while to copy each article into a new page in the wiki, then start linking them after all the data has been compiled into the wiki.
Everything is Possible
Wladimir Palant

Re: Moving documentation into a wiki

Post by Wladimir Palant »

Because copying articles would be a waste of volunteer time. I'm already pretty far with the automated import of contents - the issues that remain are structural (need to deal with links that point to different websites in different languages, need to finish coding content classes for a few special pages etc).
Wladimir Palant

Re: Moving documentation into a wiki

Post by Wladimir Palant »

It is almost done: blog/new-website-version-ready-for-testing

Unfortunately, you still cannot play around with translations, giving everybody access is something that still needs to be done. On the other hand, it wouldn't be much fun due to Anwiki bug 104.
Wladimir Palant

Re: Moving documentation into a wiki

Post by Wladimir Palant »

You should be good to go now - anybody who has more than 5 forum posts (with at least one being more than a week old) can now log into Anwiki with the same user name/password as in the forum. The original plan was to be able to make an exception for individual users but with permissions in phpBB being a horrible mess this isn't working for now. I also would like to create an Anwiki session automatically so that you won't need to log in if you are already logged into the forum.

I allowed all non-modifying actions as well as translating. Changes are now pushed into Mercurial as well, once per hour (https://hg.adblockplus.org/www/). I would like to have individual changes there eventually, along with real user name and comment.
Michael
Posts: 1361
Joined: Sat Dec 19, 2009 12:29 pm

Re: Moving documentation into a wiki

Post by Michael »

Is the "translate" option the one that should be chosen to update one language of a particular page? There doesn't appear to be any other relevant link.
Wladimir Palant

Re: Moving documentation into a wiki

Post by Wladimir Palant »

Yes, that's the one. Page structure cannot be changed, it only allows to change the text.
Michael
Posts: 1361
Joined: Sat Dec 19, 2009 12:29 pm

Re: Moving documentation into a wiki

Post by Michael »

There appears to be a problem with some images on anwiki/en/screenshots.
The image "[link]" cannot be displayed, because it contains errors.
Locked