January 2018 - Freeswitch-docs - FreeSWITCH Mailing Lists

Autogenerating Variables docs
by Ryan Harris 30 Jan '18

30 Jan '18

Hi list, Take a look at https://freeswitch.org/confluence/display/FREESWITCH/Autogenerated+DTMF+Var… I was getting a little exhausted with Confluence automatic formatting. What I really wanted was a simple UI to catalog the variables and then generate the pages as I saw fit. I also wanted to tune the formatting so that there weren't any inconsistencies. So I made a simple Django app. You create a variable, assign it one or more categories, give it any number of usages (or none), include cross-references to other pages... Then, when you want to add it to confluence, it spits out markup like what I've linked above. Hopefully this will improve documentation efforts -- at least for the variables catalog. What do you think? I'll put the source up on stash. Would anyone be willing to use this locally? I can also set the app on a public domain.

3 4

Channel variables page
by Stanislav Sinyagin 29 Jan '18

29 Jan '18

hi, the channel variables page is getting extremely long and difficult to view and to edit. Maybe it makes sense to split it by modules? Whenever I need to check some variable, I search it in google and then click on the old wiki page :-)

3 21

Channel Variables Legacy Links
by Ryan Harris 29 Jan '18

29 Jan '18

Hi list, I'm inferring that since the content on Dialplan/Variables is the same as on the legacy wiki individual variable pages that the links on Dialplan/Channel Variables can be updated to reflect this. I am going by section, so it can be easily reverted if this wasn't intended. ry

3 6

Codebase Overview Dreams
by Ryan Harris 27 Jan '18

27 Jan '18

Hi list, While browsing the documentation, I got the essence of a dream that someone once had -- an overview of the codebase. If you look in Bit Bucket under "For Consideration", there are a bunch of pages with the names of config files linking to the old SVN source tree! Anecdotally, it helps me to map high level software behaviors with the underlying code. It's much easier to find out where to look when there's a guide that walks users through the source tree. A light explanation goes a long way in empowering the user to explore. Can anyone point me to any previous attempts at this? A codebase overview/walkthrough provides for a /great/ user experience (to the right users :). It's my goal to invest some time in it when docscaping is complete. ry

1 0

Bit Bucket Changes
by Ryan Harris 27 Jan '18

27 Jan '18

Hi list, I made the Bit Bucket section private. I guess there's an argument for keeping it public, but I think it's a better user interaction to have it hidden. I've added the three SIP provider configs that seem to be defunct under a new section in Bit Bucket called "Should Archive". I added a new section called "For Consideration". The idea behind this is to discuss the merits of pages that could be archived, but maybe shouldn't be. I'm going to send a different mail in just a moment discussing what I've put in that section so far. ry

1 0

XML Meta Page Indexing Complete
by Ryan Harris 26 Jan '18

26 Jan '18

I just finished indexing all documents that reference XML configuration in the XML Meta Page. I noticed a lot of repeated information. I think it's best to strictly require that things like directory locations and config params are cross-referencing a primary page. Since I have a full index of all the pages that have this information, it will be a lot easier for me to set up these cross-references. I'm going to start categorizing the XML Meta Page now. Let me know if you have any suggestions/requests.

2 1

Meta Pages? Meta Pages
by Ryan Harris 26 Jan '18

26 Jan '18

I hope we can address the documentation clutter before we get featured on an episode of Hoarders :) The natural and intuitive way to address the situation is to try to move the existing pages wherever we think they should go. However, it's not entirely clear *where* they should really go. Think about configuration. Do we include information about serving configuration from the SWIGed languages in the configuration section? Or do we put those in sections dedicated to specific programming languages. Often the sections can't be about one specific thing by necessity. It's a dilemma. And, right now, it would be destructive to try to reorder the pages beyond what's already been done. It will just make the documentation inconsistent and more likely cause confusion. Instead, I'd like to propose the idea of "meta pages". The idea is that their only purpose is to link to other pages. In the XML metapage, we link to *all pages* that discuss XML. In the Lua metapage, Lua. Ad infinitum. These pages, I think (I hope), will be able to help us find a natural and logical way to organize everything. I'm going to start working on it now. Tell me what you think! ry

2 1

Defunct Provider Configurations
by Ryan Harris 26 Jan '18

26 Jan '18

It seems that the following providers are no longer operating: FreeDigits https://freeswitch.org/confluence/display/FREESWITCH/Provider+Configuration… GrnVOIP/ezcall https://freeswitch.org/confluence/display/FREESWITCH/Provider+Configuration… Free World Dialup https://freeswitch.org/confluence/pages/viewpage.action?pageId=13174208 Can we archive or remove these? They're just taking up space at this point.

2 3

No-more-scrolly in the sidebaroli
by Ryan Harris 26 Jan '18

26 Jan '18

I did a little house keeping and organized some things. 1. I'm not sure if I'm happy with having the "prototypes" section when obviously there is an examples sections. The idea of having a prototypes section is to show people more complete examples where the examples section could be confined to just snippets. 2. I also added an "auxiliary knowledge and utilities" section. It seems like a good compromise between deleting non-FreeSWITCH documentation, but also not letting it clutter up and ed-emphasize the actual documentation. Please let me know if anything should be changed or if you have any comments on how things should be handled.

1 0

Lua - switch_priority_t
by Ryan Harris 18 Jan '18

18 Jan '18

event:setPriority() wants something like SWITCH_PRIORITY_HIGH, SWITCH_PRIORITY_LOW, but how do we do that in Lua? The wrapper is expecting switch_priority_t, an enum, but I can't find out if there is something callable that will make a switch_priority_t

1 0