Item9702: Document all template directives and macros

Priority: Enhancement
Current State: Closed
Released In: 1.1.4
Target Release: patch
Applies To: Engine
Component: Documentation
Reported By: DanDascalescu
Waiting For:
Last Change By: GeorgeClark
While editing templates, I ran across a few apparent macro invocations (template directives? how does a user distinguish?) that weren't documented in System.Macros or System.Skins#Settings_in_Skins:

  • QUERYPARAMSTRING
  • REVARG

-- DanDascalescu - 17 Sep 2010

George has started a great initiative to get these things (1) identified and (2) documented. I'd like to add a second step:
  1. Identify
  2. Eliminate
  3. Document
These template tokens have always been a problem; they are usually the result of a coder not fully understanding how to use templates just hacking in the simplest thing. The more we can do to eradicate these stains, the better.

For example, the ubiquitous SPLIT token could be replaced by three macro definitions, top, repeat and bottom. Of course the use of thse macros also need to be documented.

-- CrawfordCurrie - 18 Sep 2010
 
Topic revision: r13 - 17 Dec 2011, GeorgeClark
 
The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. see CopyrightStatement. Creative Commons License