<div dir="ltr">Hi Pat!<br><div class="gmail_extra"><br><div class="gmail_quote">On Tue, Oct 6, 2015 at 1:40 PM, Pat Beirne <span dir="ltr"><<a href="mailto:patb@apphostcanada.ca" target="_blank">patb@apphostcanada.ca</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">Good afternoon,<br>
<br>
I just joined last last week, and I've been moving some old-wiki stuff<br>
over.<br>
<br>
I spent some time last Friday on the sprint, and over the weekend I did<br>
more, so I'm up to about 40 pages. I have some questions before I go<br>
much further:<br>
<br>
1) could somebody look at 2-3 of my moves and see if I'm doing it correctly?<br></blockquote><div><br></div><div>Sure. </div><div><br></div><div><a href="https://freeswitch.org/confluence/display/FREESWITCH/Dialplan+FollowMe">https://freeswitch.org/confluence/display/FREESWITCH/Dialplan+FollowMe</a><br></div><div><br></div><div>I do prefer to use code block with title as a summary, like in this page: <a href="https://freeswitch.org/confluence/display/FREESWITCH/FreeSWITCH+1.6+Video">https://freeswitch.org/confluence/display/FREESWITCH/FreeSWITCH+1.6+Video</a></div><div><br></div><div>We have a page trying to cover the basic guidelines for the docs, take a look here <a href="https://freeswitch.org/confluence/display/FREESWITCH/Confluence+Wiki+Standards+and+Guidelines">https://freeswitch.org/confluence/display/FREESWITCH/Confluence+Wiki+Standards+and+Guidelines</a></div><div><br></div><div>Other than that, as we talked in #freeswitch-docs, you're doing a GREAT JOB, thank you so much!</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
<br>
2) I've been using {code for large blocks of external non-config code<br>
(such as Python, javascript or .xml) and I've been using {noformat for<br>
the short one-liners. The {noformat is black-text-on-white-rectangle and<br>
I think it looks better for short snips.....is that ok?<br></blockquote><div><br></div><div>I do prefer to use {code}, if the line is big it'll force the user to scroll horizontally like this one <a href="https://freeswitch.org/confluence/display/FREESWITCH/Dialplan+FollowMe#DialplanFollowMe-FollowMeDialplanExample1">https://freeswitch.org/confluence/display/FREESWITCH/Dialplan+FollowMe#DialplanFollowMe-FollowMeDialplanExample1</a></div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
<br>
3) I've written a long-ish page about "how to write an endpoint" "New<br>
Endpoints" and it's a child under "New Modules". Could somebody please<br>
skim it and see if it's appropriate for this doc repository? It's<br>
written informally, with lots of 2nd person "you should" and "you can"<br>
phrases; I can clean that up if neeeded. Currently this page is visible<br>
to -doc and -dev members only. I hope to release it to the public in a<br>
day or so, but I'd like some feedback first. And ideally, if a -dev<br>
person could skim it and see if it's technically correct. Please.<br></blockquote><div><br></div><div>We'll review soon.</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
<br>
4) There are lots of references to the source code, and I'd like to add<br>
hyperlinks to the source-api pages. I see that some other authors have<br>
managed to do that with crazy links like<br>
<a href="http://docs.freeswitch.org/structswitch__io__routines.html#2fac41d9629ee59aea0739d14b195e69" rel="noreferrer" target="_blank">http://docs.freeswitch.org/structswitch__io__routines.html#2fac41d9629ee59aea0739d14b195e69</a><br>
where the anchor name is some kind of hash. Is there a way for me (as<br>
docs author) to find and use these anchor-ed links? Will the links<br>
change the next time the dev run Doxygen?<br></blockquote><div><br></div><div>Not sure...</div><div><br></div><div>I think this doc is a little outdated, not sure if we should link to it. Can you send me the page that is linking to this?<br></div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
<br>
<br>
Like I said, I'll hold off doing more bulk moves until I hear back on<br>
topic 1) above. And I'll keep that "New Endpoints" page hidden until I<br>
hear feedback on 3) above.<br>
Many thanks.<br></blockquote><div><br></div><div>Keep up with the good job.</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
<span class=""><font color="#888888"><br>
--<br>
Pat Beirne<br>
AppHostCanada<br>
<br>
<br>
<br>
_______________________________________________<br>
Freeswitch-docs mailing list<br>
<a href="mailto:Freeswitch-docs@lists.freeswitch.org">Freeswitch-docs@lists.freeswitch.org</a><br>
<a href="http://lists.freeswitch.org/mailman/listinfo/freeswitch-docs" rel="noreferrer" target="_blank">http://lists.freeswitch.org/mailman/listinfo/freeswitch-docs</a><br>
</font></span></blockquote></div><br><br clear="all"><div><br></div>-- <br><div class="gmail_signature"><div dir="ltr">Ítalo Rossi<div><a href="mailto:italo@freeswitch.org" target="_blank">italo@freeswitch.org</a></div></div></div>
</div></div>