[Freeswitch-docs] Inconsistency in mod_dptools pages

[Bote Man]

One of the other editors recommended I keep the manual index, at least while
we are still building the automated one. IIRC it contains links to other
pages outside that hierarchy so it's worth checking if that is useful.

I thought it might be helpful to have both, but I can see how it would be
confusing to people.

I have been hot and cold with editing, so it has been a few weeks since I
have been in there. I need to refresh my memory before I commit to a
decision on that.

Bote


-----Original Message-----
From: freeswitch-docs-bounces at lists.freeswitch.org
[mailto:freeswitch-docs-bounces at lists.freeswitch.org] On Behalf Of Stanislav
Sinyagin
Sent: Wednesday, 18 February, 2015 06:04
To: FreeSWITCH Docs Team
Subject: Re: [Freeswitch-docs] Inconsistency in mod_dptools pages

I think it also makes sense to remove the manual index completely from
https://freeswitch.org/confluence/display/FREESWITCH/mod_dptools
and rely on the automated children list.

what do you think?



On Wed, Feb 18, 2015 at 12:10 AM, Bote Man <bote_radio at botecomm.com> wrote:
> I started to simplify the page names under mod_dptools and only made 
> it as far as you currently see them listed. I was reluctant to resume 
> the process until I got consensus that this is the desired approach, 
> as the page name becomes the hyperlink to that page. Confluence is 
> supposed to update internal links between pages when the page name 
> changes, but I have seen a few odd cases where it did not.
>
> Also, when page names contain special characters Confluence creates a 
> numeric hyperlink to the page instead of the recognizable link 
> containing the text name of the page, so the preference is always to 
> avoid special characters in page names.
>
> I was adding the "excerpt" macro to the About section of the child 
> pages so that its contents would also appear in the macro on the 
> parent page that lists all the child page names, but the text inside 
> the excerpt should be kept short for this reason. When the excerpt is 
> configured to be "inline" it looks just like part of the sentence on 
> the page so it can serve two functions.
>
> So I would just use the short "friendly" page name for record_session.
>
> Thanks for pointing this out.
>
> Bote
>
>
> -----Original Message-----
> From: Stanislav Sinyagin
> Sent: Tuesday, 17 February, 2015 17:25
> Subject: [Freeswitch-docs] Inconsistency in mod_dptools pages
>
> hi,
>
> If you look at the children list of
> https://freeswitch.org/confluence/display/FREESWITCH/mod_dptools
> you see that there are two ways of naming the pages:
>
> 1. By command name, like "detect_speech"
> 2. Long space-delimited name, like "mod_dptools: Dialplan Tools record 
> session"
>
> What is the correct way of naming and linking pages? I guess it's #1, 
> but I'm new to this Confluence, so I better follow some common standard.
>
> Also,
> https://freeswitch.org/confluence/display/FREESWITCH/record
> has a broken link to "record_session" -- I guess I can modify it to 
> refer to the Confluence page, as soon as the first question is resolved,
right?
>
>
> cheers,
> stan
>
> _______________________________________________
> 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