User Tools

Site Tools


develop:contextual_help

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
develop:contextual_help [2017/05/02 19:28]
mariez
develop:contextual_help [2017/05/02 19:33] (current)
mariez [Example]
Line 1: Line 1:
 +====== Contextual Help ======
 +
 +
 +----
 +
 +
 +The Contextual Help topics can be placed anywhere with the function: ''​Help("​topic"​)''​. ​
 +
 +This "​topics"​ are in the **/​lists/​admin/​help/​** directory, divided by language. ​
 +
 +All the content of this /help directory is modified by the public repository:
 +[[https://​github.com/​phpList/​phplist-lan-help/​]]
 +
 +This Help("​topic"​) function print a link in the page, to open a URL like this: **/​lists/​admin/​help/?​topic=topic**
 +
 +
 +----
 +
 +
 +==== Example ====
 +
 +In the Send a Campaign page, this is the Contextual Help for the field Subject:
 +
 +{{:​develop:​contextual-help-example.png?​nolink|}}
 +
 +
 +That is the result of echo the function Help('​subject'​):​
 +
 +{{:​develop:​contectual-help-code.png?​nolink|}}
 +
 +
 +And that Contextual Help, in an english installation,​ will open the file:  **/​lists/​admin/​help/​en/​subject.php**.
 +Or, in a spanish installation,​ will open the file:  **/​lists/​admin/​help/​es/​subject.php**.
 +
 +
  
develop/contextual_help.txt · Last modified: 2017/05/02 19:33 by mariez

Resources
Contact Us

e: info@phplist.com

Boring Bit

phpList is a registered limited company

UK Company No. 07582966

VAT Registration 122 0788 37

© phpList 2016