?
avatar yild
yild
4 Aug 2016

New feature.

Add new help server (to global configurations -> system tab -> help server list) via language packs manifest file or new language key with server url.

My TT Coordinator was too through and JHELP_COMPONENTS_ strings ware translated to strings that match our language (PL) wiki with help topics. ATM there are only English and French help servers listed in "help servers" list (global configuration->system tab).

With this translation issue either of the server works, Joomla can't display correct help page and throw

RuntimeException
Error fetching page from MediaWiki API: The page you specified doesn't exist

error.

If we could extend language pack manifest file with info about language help server it might resolve this issue but it would require install.php to add new help server to db and remove it when package is uninstalled.

Second option would be to add new key to language file i.e:
JHELP_COMPONENTS_SERVER_URL="http://wiki.joomla.pl"
If this string is empty use settings from global configuration, if set then use provided url as help server.
This option could use of key override if administrator wanted to select i.e. english help file (that is most up to date) instead of the one provided by key in language file (again if override string is empty then use global configuration setting).

avatar yild yild - open - 4 Aug 2016
avatar yild yild - change - 4 Aug 2016
The description was changed
avatar yild yild - edited - 4 Aug 2016
avatar brianteeman brianteeman - change - 4 Aug 2016
Labels Added: ?
avatar brianteeman brianteeman - change - 4 Aug 2016
Category Language & Strings Multilanguage
avatar infograf768
infograf768 - comment - 4 Aug 2016

The JHELP_COMPONENTS_etc. strings should not be translated.


This comment was created with the J!Tracker Application at issues.joomla.org/joomla-cms/11434.

avatar brianteeman
brianteeman - comment - 4 Aug 2016

What is the correct way for a language to be added to the helpsites.xml? I looked in the docs but didnt see anything but I might have searched wrong as i only found this https://docs.joomla.org/Help_system/Helpsites_XML_format

avatar yild
yild - comment - 4 Aug 2016

I wrote this issue hastily... there are other things to consider:

Are there any docs that would explain this wiki api proxy technicalities mentioned in https://docs.joomla.org/Help_system/Help_servers ? Is there any code available ?

avatar mbabker
mbabker - comment - 4 Aug 2016

Is there any code available ?

https://github.com/joomla/help.joomla.org

Specifically, you'll want to look at https://github.com/joomla/help.joomla.org/blob/master/src/Model/HelpScreenModel.php which has all the code dealing with pinging the MediaWiki instance it's configured to work with.

Just for reference, the help screen system is basically a three step thing. The CMS issues a request to the "proxy" server (right now core lists English and French) and that proxy server takes care of fetching data from MediaWiki and rendering the page.

avatar yild
yild - comment - 5 Aug 2016

namespaces proxy servers... phew much too complicated. Will have to try to assemble this 'toolchain' first on VM and test it.

@infograf768 I discussed this with my TC and we will comment our translated stings... for now.

avatar brianteeman
brianteeman - comment - 5 Aug 2016

Closing it here as there is nothing to do

avatar brianteeman brianteeman - change - 5 Aug 2016
Status New Closed
Closed_Date 0000-00-00 00:00:00 2016-08-05 15:54:43
Closed_By brianteeman
avatar brianteeman brianteeman - close - 5 Aug 2016

Add a Comment

Login with GitHub to post a comment