# HG changeset patch
# User Wuzzy
# Date 1460230132 -3600
# Node ID 30cc2f85c5e754a65a1d34a6062cdae61c985027
# Parent  e8d5c66477b77a996aada36d470ba47a78d5f6fe
LuaLibraries: Explain proper usage of loc()

diff -r e8d5c66477b7 -r 30cc2f85c5e7 LuaLibraries.wiki
--- a/LuaLibraries.wiki	Sat Apr 09 13:47:49 2016 +0100
+++ b/LuaLibraries.wiki	Sat Apr 09 20:28:52 2016 +0100
@@ -25,7 +25,29 @@
 
 Returns the localised string of `text` or, if it is not found, it returns `text`.
 
+In order for your text to be taken by the string collection tools (so the string becomes available for translation), you have to follow a few simple syntax rules:
 
+ * `text` _must_ be entirely a literal string
+ * The text _must_ be enclosed in double quotes
+ * You _must_ use the exact character sequence “`loc("`” to initiate the text, no spaces in between are permitted
+
+Valid example:
+<code language="lua">
+AddCaption(loc("Hello World"))  -- Displays “Hello World” translated into your language
+</code>
+
+These are all _incorrect_ usages of the `loc` function:
+<code language="lua">
+local l
+l = loc( "Hello World")    -- Contains space. This is valid Lua code but
+l = loc ("Hello World")    -- Contains space
+l = loc('Hello World')     -- Not double quotes
+local str = "Hello World"
+l = loc(str)   -- Not a literal string
+l = loc(str .. ", how are you?")   -- Only partially a literal string
+</code>
+
+Note these examples do _not_ violate Lua syntax, it is in your responsibility to follow the syntax rules listed above.
 
 == Utils ==