1This is a macro substitution plugin which enables substitutions of both words and longer 2strings of text. 3 4Basic Syntax: #@Macro_Name@# 5 6It provides an administrative panel which makes for simple adding, editing and deletion 7of macros. 8 9Much of the functionality of this plugin can be more easily implemented with Dokuwiki's 10own entities facility: http://www.dokuwiki.org/entities. The advantage of TextInsert 11comes when dealing with extended blocks of text and with its ability to include other 12macros inside the primary macro definition. That is, it can accept: 13 14MACRO_1 This macro can include #@MACR0_2@# inside it. 15MACRO_2 a second macro 16 17The result is: 18 This macro can include a second macro inside it. 19 20It accepts only one level of macro inclusion, so that if MACRO_3 were included in 21MACRO_2, MACRO_3 would not be rendered. 22 23The macro definitions will also accept entities defined dokuwiki's conf/entities.conf and 24user-defined entities conf/entities.local.conf. Entities will be replaced in both the 25primary and the included macros. 26 27HTML Support 28#Macro_HTML@# 29A macro name with the _HTML suffix will be output as HTML, whereas without the _HTML suffix the 30HTML markup will be treated as literals. With it, <p> creates a paragraph; wthout it the <p> 31markup is printed to the screen. 32 33Translation Support 34#@LANG_name@# 35If a macro has this format, textinsert checks the file's namespace for a language specified 36as an ISO abbreviation, for instance nl for Dutch or de for German -- as in de:my_file. If it finds 37a language specification, it will check the textinsert/lang directory for either macros.php or a lang.php 38file in the relevant language directory, for instance lang/de/lang.php. It will then look for a 39$lang['name'] entry in lang.php or a $lang_<iso>['name'] entry in macros.php, and if 40it finds one, it will substitute this for the macro. Otherwise, it will substitute the entry for 41LANG_name in the textinsert database. So, there must be a default entry in that database. 42 43Translation macros can be embeded in other macros, including other translation macros. 44And other macros can emdedded in translation macros. They also accept entities, as 45described above. 46 47For HTML output, HTML tags are accepted in translation macros, but for the HTML 48to become effective, these must be included in a standard HTML macro definition 49string. In effect, they must be doubly bound to the HTML 50 51See http://dokuwiki.org/plugin:textinsert for further information. 52 53 54 55 56