[Freeswitch-docs] Autogenerating Variables docs

[Bote Man]

Confluence editing is an acquired knack, to be sure. I learned to tolerate its quirks since so much of this requires manual intervention to update the pages.

I know nothing about Django so I don't know how others would use your app.

Your demo page looks as good as Confluence could be expected to look. 

I suggest a "Type" field that declares whether it's a Boolean, string, numeric type to see that at a glance.

Also, don't forget about Confluence "labels" (tags, really). Those are important to tie together related pages wherever they sit in the ToC tree. There's a pretty good established list at the bottom of
https://freeswitch.org/confluence/display/FREESWITCH/Confluence+Wiki+Standards+and+Guidelines


Looks good to me, though.

Thank you!

Bote




-----Original Message-----
From: Freeswitch-docs [mailto:freeswitch-docs-bounces at lists.freeswitch.org] On Behalf Of Ryan Harris
Sent: Tuesday, 30 January, 2018 11:24
To: freeswitch-docs at lists.freeswitch.org
Subject: [Freeswitch-docs] Autogenerating Variables docs

Hi list,

Take a look at
https://freeswitch.org/confluence/display/FREESWITCH/Autogenerated+DTMF+Variables

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.