Hello,
today the PV&T are documented in several places: - core PV&T were on dokuwiki page - PV exported by modules in the README
As of now, all PV&T from core were moved in pv module, but they are sill documented on dokuwiki page.
However, we should get to a consistent way. My suggestion is to document PV&T in docuviki, mentioning which module to load to become available. We keep a single page a reference, being easier to find all the PV&T, rather than going over all modules' README. I think user experience is more straightforward.
The module readme should maintain a small section, listing the names of PV&T plus a link to dokuwiki page. Any other opinions?
I am just about to document the new $T_rpl(pv) and $T_req(pv) pseudo-variables from TM, so I am waiting to do it in the proper place: http://lists.kamailio.org/pipermail/devel/2008-December/017108.html
Cheers, Daniel
On 12/08/08 13:42, Juha Heinanen wrote:
Daniel-Constantin Mierla writes:
The module readme should maintain a small section, listing the names of PV&T plus a link to dokuwiki page. Any other opinions?
sounds fine to me or just a link without even listing the names.
ok, so, from now on, please document PV & Transformations in the dokuwiki page, grouped by module name, e.g.: http://www.kamailio.org/dokuwiki/doku.php/pseudovariables:devel#tm_module_ps...
For devels, when they have time (if that happens soon :-) ), please migrate existing PV&T from modules to dokuwiki. Leave in the module a section with Exported pseudo-variables containing the link to the dokuwiki page.
Cheers, Daniel
-
Daniel-Constantin Mierla -
jh＠tutpro.com