Difference between revisions of "FAQ variables"

Revision as of 00:01, 9 August 2008

Introduction

The variables below can be used in FAQ summary text and FAQ answer text. Those that refer to translatable items all use the correct language by default, so you can leave them unchanged in your translation and the right thing will happen.

Journal variables

• [[username]] will be replaced by the viewing user's username. If the user isn't logged in, then it will be replaced by exampleusername.
• [[journalurl]] will be replaced by the viewing user's journal URL. If the user isn't logged in, then it will be replaced by http://exampleusername.livejournal.com. In both cases, the URL will be autolinkified unless it's inside an <a> tag or wrapped within <lj-raw></lj-raw>.
• [[journalurl:username]] will be replaced by the journal URL of that username.

FAQ variables

• [[faqtitle:FAQ#]] will be replaced by the title of the FAQ with that number in the translation that the user is using.

UI variables

Variables

• [[gmlitem:itemcode]]: replaced with the translation string in the user's language for itemcode, in the general domain (see below).
• [[wmlitem:itemcode]]: same as above, but for the widget domain (see below).
• [[fmlitem:FAQ#.1question]]: like [[faqtitle:FAQ#]], except that searching the FAQs will return occurences of the search term in [[fmlitem:FAQ#.1question]] but not in [[faqtitle:FAQ#]].
• [[fmlitem:FAQ#.2answer]] and [[fmlitem:FAQ#.3summary]]: like [[fmlitem:FAQ#.1question]], except that they refer to the FAQ answer or summary, not the question.

Finding out the item code and whether to use gmlitem or wmlitem

There are two ways to figure out which item code you want and whether you should use gmlitem or wmlitem, depending on whether you have translate privs or not.

If you have translate privs: go to http://www.livejournal.com/translate/edit.bml?lang=fr (replace fr with a language you have translation privs in). In the search pane (upper left), select "English (LJ)" as the language and "(all)" as the area, enter a fragment of the text you're searching for in the text field, then hit Search. A list of results should display in the list pane (bottom left). Click on Page 1 (hopefully there will be only one - if not, you probably want to use a longer fragment of your message as the text string).

This will open a detailed list in the edit frame (large frame on the right). In that frame, check the English text of each item against the one you want. When you found it, look for the Code: line. This will give you the item code. Note that there may be several item codes having the same text. In that case, the one you want is the one that starts with the pathname of the web page the text is in, such as /index.bml or /feedback/ads.bml. If the itemcode starts with "/", you should use gmlitem. Otherwise, it will start with "widget." and have the word [widget] (between braces) left of it. In that case, you should use wmlitem and the item code is the part starting with "widget." as the [widget] tag isn't part of the item code itself. You can also use the method below to double-check.

If you don't have translate privs: go to the page that contains the text, then append ?uselang=debug to the URL (or &uselang=debug if the URL already contains a ?). This will display item codes instead of the actual text. (Note that this will likely not work if the page is displayed after processing a form, as it will not resend the form data.) Then, locate the item code.

• If it starts with a "/", it should be used as is, with gmlitem.
• If it starts with ".widget", it should be used without the leading ".", with wmlitem.
• Otherwise, it should start with "." followed by a word other than "widget". In that case, append it to the path of the URL and use the result with gmlitem. (That is, if you're viewing http://www.livejournal.com/editpics.bml and the item code displayed is ".error.unknowntype", use "/editpics.bml.error.unknowntype".)