[Freeswitch-users] mod_xml_curl + variables documentation

[Cal Leeming [Simplicity Media Ltd]]

I've made some further improvements.

The channel variables page now contains placeholders for all the variables
that were missing (approx 119 added).

http://wiki.freeswitch.org/wiki/Channel_Variables

I have also created/updated the following variable documentation pages with
the info collected from mod_xml_curl docs

http://wiki.freeswitch.org/wiki/Variable_sip_auth_realm
http://wiki.freeswitch.org/wiki/Variable_sip_auth_username
http://wiki.freeswitch.org/wiki/Variable_sip_auth_method
http://wiki.freeswitch.org/wiki/Variable_sip_user_agent
http://wiki.freeswitch.org/wiki/Variable_sip_request_host
http://wiki.freeswitch.org/wiki/Variable_sip_request_port
http://wiki.freeswitch.org/wiki/Variable_sip_profile
http://wiki.freeswitch.org/wiki/Variable_sip_from_port
http://wiki.freeswitch.org/wiki/Variable_sip_from_user
http://wiki.freeswitch.org/wiki/Variable_sip_from_host
http://wiki.freeswitch.org/wiki/Variable_sip_to_host
http://wiki.freeswitch.org/wiki/Variable_sip_to_port
http://wiki.freeswitch.org/wiki/Variable_sip_to_user
http://wiki.freeswitch.org/wiki/Variable_sip_contact_host
http://wiki.freeswitch.org/wiki/Variable_sip_contact_port
http://wiki.freeswitch.org/wiki/Variable_sip_contact_user

As such, I have also removed the field descriptions from mod_xml_curl and
placed the necessary references back to the correct documentation.

Could someone please review this and make sure it's in line with
quality/expectations etc.

Cal

On Sat, Dec 29, 2012 at 5:38 PM, Cal Leeming [Simplicity Media Ltd] <
cal.leeming at simplicitymedialtd.co.uk> wrote:

> Ah, I was not aware of these pages, no idea how I managed to miss it!!
>
> Thanks for letting me know :)
>
> Cal
>
>
> On Sat, Dec 29, 2012 at 4:24 AM, Steven Ayre <steveayre at gmail.com> wrote:
>
>> Please read the wiki source of the
>> http://wiki.freeswitch.org/wiki/Channel_Variables and
>> http://wiki.freeswitch.org/wiki/Variable_sip_auth_username wiki pages.
>>
>> The variables pages contain <onlyinclude> markup while the channel
>> variables page liberally includes the descriptions from the Variable_
>> pages. That means the descriptions can be maintained in a single location
>> and reused across the wiki, and changes automatically update everywhere.
>>
>> I notice you have written a new sip_auth_username section instead of
>> including the existing one (and possibly modifying it), so I'm not sure
>> whether you're aware of this feature.
>>
>> Regards,
>> Steve
>>
>>
>>
>> On 29 Dec 2012, at 00:50, "Cal Leeming [Simplicity Media Ltd]" <
>> cal.leeming at simplicitymedialtd.co.uk> wrote:
>>
>> Spent several hours working on further re-structuring the mod_xml_curl
>> docs, but I'm still not happy with it :/
>>
>> http://wiki.freeswitch.org/wiki/Mod_xml_curl
>>
>> As mod_xml_curl request variables can be very difficult to figure out, I
>> have started to document which request variables apply where, which are
>> common, which are section specific etc.
>>
>> However - there is also a huge lack of variable documentation, and
>> although this isn't strictly a mod_xml_curl thing, it would benefit many
>> others areas too if we had all these documented.* *
>>
>> Although the mod_xml_curl docs page isn't the proper home for variable
>> descriptions, it will suffice for now until we have them all collected.
>>
>> For example:
>> http://wiki.freeswitch.org/wiki/Mod_xml_curl#sip_user_agent
>> http://wiki.freeswitch.org/wiki/Mod_xml_curl#sip_request_port
>>
>> Compared to:
>> http://wiki.freeswitch.org/wiki/Variable_sip_user_agent
>> http://wiki.freeswitch.org/wiki/Variable_sip_request_port
>>
>> To some extent, I think that the concept of having individual pages for
>> each variable is not very user friendly - would anyone care to speculate on
>> whether this should be phased out in favour of a single page with all the
>> variables on?
>>
>> Either way, if anyone has maybe a spare 10 minutes to contribute towards
>> getting these variables documented, it would really help reduce the work
>> load (some are a simple Google job, others require trawling through source
>> code).
>>
>> Cal
>>
>> _________________________________________________________________________
>> Professional FreeSWITCH Consulting Services:
>> consulting at freeswitch.org
>> http://www.freeswitchsolutions.com
>>
>> 
>> 
>>
>> Official FreeSWITCH Sites
>> http://www.freeswitch.org
>> http://wiki.freeswitch.org
>> http://www.cluecon.com
>>
>> FreeSWITCH-users mailing list
>> FreeSWITCH-users at lists.freeswitch.org
>> http://lists.freeswitch.org/mailman/listinfo/freeswitch-users
>> UNSUBSCRIBE:http://lists.freeswitch.org/mailman/options/freeswitch-users
>> http://www.freeswitch.org
>>
>>
>> _________________________________________________________________________
>> Professional FreeSWITCH Consulting Services:
>> consulting at freeswitch.org
>> http://www.freeswitchsolutions.com
>>
>> 
>> 
>>
>> Official FreeSWITCH Sites
>> http://www.freeswitch.org
>> http://wiki.freeswitch.org
>> http://www.cluecon.com
>>
>> FreeSWITCH-users mailing list
>> FreeSWITCH-users at lists.freeswitch.org
>> http://lists.freeswitch.org/mailman/listinfo/freeswitch-users
>> UNSUBSCRIBE:http://lists.freeswitch.org/mailman/options/freeswitch-users
>> http://www.freeswitch.org
>>
>>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.freeswitch.org/pipermail/freeswitch-users/attachments/20121229/d0c17854/attachment.html