[Freeswitch-docs] Request for comment on new channel variable catalog

[Ítalo Rossi]

This is looking very good. Great work.

I'd say only a few minor changes:

Use the default fs toc macro, I think the way it create the sections like 1
1.1 1.2 looks better.

And if you use h1 the variable get anchor links automatically in the toc,
easy to reference them.


Em sex, 2 de fev de 2018 às 19:47, Stanislav Sinyagin <ssinyagin at gmail.com>
escreveu:

> if there's no objection, let's make these new pages productive, and
> hide the old one.
>
> On Fri, Feb 2, 2018 at 11:42 PM, Bote Man <bote_radio at botecomm.com> wrote:
> > Well, if there is a way to do that it would be either a LOT of manual
> work
> > or a script that somehow magically knows which terms to form into links
> > suitable for Confluence.
> >
> >
> >
> > Even if such a list were generated from the source code or Doxygen(?) we
> > would still need some way to form the links. I have no good ideas for
> that.
> > Documentation is largely a manual endeavor, even in the tech field.
> >
> >
> >
> > Bote
> >
> >
> >
> >
> >
> > From: Stanislav Sinyagin [mailto:ssinyagin at gmail.com]
> > Sent: Friday, 02 February, 2018 17:23
> > To: Bote Man <bote_radio at botecomm.com>; FreeSWITCH Docs Team
> > <freeswitch-docs at lists.freeswitch.org>
> >
> >
> > Subject: Re: [Freeswitch-docs] Request for comment on new channel
> variable
> > catalog
> >
> >
> >
> > I thought more of a global way to reference variables from other pages.
> Also
> > a global index page with just names wouldn't be too bad.
> >
> >
> >
> >
> >
> >
> >
> > On Feb 2, 2018 23:21, "Bote Man" <bote_radio at botecomm.com> wrote:
> >
> > High praise from Stan! He does good work, too.
> >
> > You can use an aspect of Confluence Table of Contents to form links
> within
> > the page, especially since they make it so insanely difficult to create a
> > simple anchor within a page.
> >
> > The way the 'FS ToC' macro that I created works is by only including the
> > higher level heading tags, I think h1, h2, possibly h3. I can't recall
> > off-hand and I can't check right now.
> >
> > You can copy an individual link to the term of interest from the ToC and
> > paste that elsewhere. It's cumbersome, but it's less cumbersome than the
> way
> > Confluence wants you to do it. Have a look at
> > https://freeswitch.org/confluence/display/FREESWITCH/Conference+Related
> >
> > I see Confluence led you down the garden path of inserting Sections :-) I
> > learned the hard way that they are a royal pain to manipulate, especially
> > when a section is the first element on a page: you aint inserting
> ANYTHING
> > before it.
> >
> > See if that ToC idea helps you. Lots of good work there, thank you.
> >
> > Bote
> >
> >
> > -----Original Message-----
> > From: Freeswitch-docs [mailto:
> freeswitch-docs-bounces at lists.freeswitch.org]
> > On Behalf Of Stanislav Sinyagin
> > Sent: Friday, 02 February, 2018 16:27
> > To: FreeSWITCH Docs Team <freeswitch-docs at lists.freeswitch.org>
> > Subject: Re: [Freeswitch-docs] Request for comment on new channel
> variable
> > catalog
> >
> > wow, excellent work, and I like the formatting better than mine.
> >
> > Next step, we need to find a way to index them. At the moment (I
> > tried) it's impossible to make links to individual variables. This needs
> > help from Confluence experts.
> >
> > On Fri, Feb 2, 2018 at 10:12 PM, Ryan Harris <ryharris at airmail.cc>
> wrote:
> >> Hi list,
> >>
> >> I've mostly completed "normalizing" the channel variables section.
> >>
> >> On this page:
> >> https://freeswitch.org/confluence/pages/viewpage.action?pageId=7766277
> >>
> >> DTMF Variables and all pages below show the new catalog.
> >>
> >> If there is _anything_ you think needs to be tweaked, please let me
> >> know. Everything can be changed with relative ease: page ordering,
> >> variable ordering, variable groups, formatting, datatypes, etc.
> >>
> >> Here are some things to look for:
> >>
> >> - check for correct data types -- we default to string when it's
> >> ambiguous/don't know
> >>
> >> - check for deprecated variables - I can mark them as such
> >>
> >> - check for variables not marked as readonly - I can mark them as such
> >>
> >>
> >>
> >> _______________________________________________
> >> Freeswitch-docs mailing list
> >> Freeswitch-docs at lists.freeswitch.org
> >> http://lists.freeswitch.org/mailman/listinfo/freeswitch-docs
> >
> > _______________________________________________
> > Freeswitch-docs mailing list
> > Freeswitch-docs at lists.freeswitch.org
> > http://lists.freeswitch.org/mailman/listinfo/freeswitch-docs
> >
> >
> > _______________________________________________
> > Freeswitch-docs mailing list
> > Freeswitch-docs at lists.freeswitch.org
> > http://lists.freeswitch.org/mailman/listinfo/freeswitch-docs
> >
> >
> > _______________________________________________
> > Freeswitch-docs mailing list
> > Freeswitch-docs at lists.freeswitch.org
> > http://lists.freeswitch.org/mailman/listinfo/freeswitch-docs
> >
>
> _______________________________________________
> Freeswitch-docs mailing list
> Freeswitch-docs at lists.freeswitch.org
> http://lists.freeswitch.org/mailman/listinfo/freeswitch-docs
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.freeswitch.org/pipermail/freeswitch-docs/attachments/20180202/25dcae2b/attachment.html>