"Key Reference" what is it exactly?

Locked
matt
Joomla! Apprentice
Joomla! Apprentice
Posts: 32
Joined: Fri Sep 23, 2005 12:14 pm

"Key Reference" what is it exactly?

Post by matt » Wed Feb 01, 2006 12:13 am

Hi,

I was going through the documentation and I realized that I didn't know what the "Key Reference" was used for. See
http://help.joomla.org/content/view/627/27/  A content item can have a Key Reference:
Key Reference: A text key that the item may be referenced by (like a help reference).

I can't find anything else in any documentation and I was wondering how I can use this key, especially for help reference.

Thanks
Last edited by humvee on Wed May 09, 2007 10:57 pm, edited 1 time in total.

User avatar
stingrey
Joomla! Hero
Joomla! Hero
Posts: 2756
Joined: Mon Aug 15, 2005 4:36 pm
Location: Marikina, Metro Manila, Philippines
Contact:

Re: "Key Reference" what is it exactly?

Post by stingrey » Wed Feb 01, 2006 12:22 am

This is the reference that is used to pull the correct help information either from help files saved locally or on an online site like help.joomla.org

When you click the help button in top right hand corner anywhere in Admin there is a reference attached to that button so it can pull the right help for that page (context sensitive help).
Rey Gigataras
http://www.wizmediateam.com <-- great team of talented Web Designers and Programmers!
http://about.me/reygigataras <-- About Me :)
Partner, Business Development & Project Manager, Event Manager, Sports Coach :D

matt
Joomla! Apprentice
Joomla! Apprentice
Posts: 32
Joined: Fri Sep 23, 2005 12:14 pm

Re: "Key Reference" what is it exactly?

Post by matt » Wed Feb 01, 2006 12:33 am

Thanks a lot for your quick and detailed reply. Please tell me if understand correctly.

Let's say that I want to develop my own component and I add my own files to the  local help folder. I could then add a button in my component with a reference attached to it. When the user would click on the button it would open my own help files. Is that correct?

Where I get confused is why would I add a key reference to an item? Unless I put my whole documentation in my users' database or if I run a documentation website.

Also, is there any documentation on how to use this reference when developing 3rd party applications?

Thanks

Matt

matt
Joomla! Apprentice
Joomla! Apprentice
Posts: 32
Joined: Fri Sep 23, 2005 12:14 pm

Re: "Key Reference" what is it exactly?

Post by matt » Wed Feb 01, 2006 1:02 am

I found part of an answer to my question:

If I have a content that I marked with Key Reference info.aboutUs I can get the content by calling it this way:

http://www.myWebSite.co.uk/index2.php?o ... fo.aboutUs

With this information you should be able to setup your own remote help server. For the rest I still don't know

Matt

User avatar
Michelle Bisson
Joomla! Ace
Joomla! Ace
Posts: 1808
Joined: Fri Aug 12, 2005 12:47 am
Location: Quebec City, Canada
Contact:

Re: "Key Reference" what is it exactly?

Post by Michelle Bisson » Thu Feb 02, 2006 4:22 am

matt,

You'll find if you visit the Translation Team forum, they will be able to help you because the translations team official partners have set up their own language help sites.
Michelle Bisson, POPcliQ, http://www.popcliq.com
Joomla / OSM Trademarks Team Member

User avatar
infograf768
Joomla! Master
Joomla! Master
Posts: 19029
Joined: Fri Aug 12, 2005 3:47 pm
Location: **Translation Matters**

Re: "Key Reference" what is it exactly?

Post by infograf768 » Fri Feb 03, 2006 6:57 am

@Matt

In Joomla!, the key reference, as far as I know, is only used when the help button is linking to a remote help server where the key is entered in a content's parameters.
If no help server is set, the help button links per default to a specific help file in the installed help folder.
It is done through a conditional statement in core.

For you to provide help by pop-up for the components you are working on, you would therefore have to provide these facilities.
The easiest would be for you to link your help button in the component interface to a help file which would be included in the component upload in its own hierarchy.
In that help file you could include various links to a remote server (via key references or directly) to provide help in different languages.

If you want to provide help through the Translation Partners servers, you would have to use the key reference system and have an agreement with each partner (and be sure the translated content is present there), which is more complex to arrange but providees also for the right encoding per language as the Partner is obviously running a site accordingly.
As of 1.1, all will any way be utf-8 when partners switch to 1.1

If you need translation for your help files, the best is for you to ask for it in the Language forum and get volunteer translations (for a GPL component).
My experience is that translators are easily volunteering if the components interest them.  ;)
Jean-Marie Simonet / infograf · http://www.info-graf.fr
---------------------------------
ex-Joomla Translation Coordination Team • ex-Joomla! Production Working Group


Locked

Return to “Archive”