<html xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:w="urn:schemas-microsoft-com:office:word" xmlns:m="http://schemas.microsoft.com/office/2004/12/omml" xmlns="http://www.w3.org/TR/REC-html40">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="Generator" content="Microsoft Word 12 (filtered medium)">
<style><!--
/* Font Definitions */
@font-face
{font-family:"Cambria Math";
panose-1:2 4 5 3 5 4 6 3 2 4;}
@font-face
{font-family:Calibri;
panose-1:2 15 5 2 2 2 4 3 2 4;}
/* Style Definitions */
p.MsoNormal, li.MsoNormal, div.MsoNormal
{margin:0in;
margin-bottom:.0001pt;
font-size:11.0pt;
font-family:"Calibri","sans-serif";}
a:link, span.MsoHyperlink
{mso-style-priority:99;
color:blue;
text-decoration:underline;}
a:visited, span.MsoHyperlinkFollowed
{mso-style-priority:99;
color:purple;
text-decoration:underline;}
p.MsoListParagraph, li.MsoListParagraph, div.MsoListParagraph
{mso-style-priority:34;
margin-top:0in;
margin-right:0in;
margin-bottom:0in;
margin-left:.5in;
margin-bottom:.0001pt;
font-size:11.0pt;
font-family:"Calibri","sans-serif";}
span.EmailStyle17
{mso-style-type:personal-compose;
font-family:"Calibri","sans-serif";
color:windowtext;}
.MsoChpDefault
{mso-style-type:export-only;}
@page WordSection1
{size:8.5in 11.0in;
margin:1.0in 1.0in 1.0in 1.0in;}
div.WordSection1
{page:WordSection1;}
/* List Definitions */
@list l0
{mso-list-id:1288580979;
mso-list-type:hybrid;
mso-list-template-ids:-345230942 580037064 67698713 67698715 67698703 67698713 67698715 67698703 67698713 67698715;}
@list l0:level1
{mso-level-tab-stop:none;
mso-level-number-position:left;
margin-left:.75in;
text-indent:-.25in;}
ol
{margin-bottom:0in;}
ul
{margin-bottom:0in;}
--></style><!--[if gte mso 9]><xml>
<o:shapedefaults v:ext="edit" spidmax="1026" />
</xml><![endif]--><!--[if gte mso 9]><xml>
<o:shapelayout v:ext="edit">
<o:idmap v:ext="edit" data="1" />
</o:shapelayout></xml><![endif]-->
</head>
<body lang="EN-US" link="blue" vlink="purple">
<div class="WordSection1">
<p class="MsoNormal">All,<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">The developers and maintainers in ROS-I are working on our official Indigo release (we always lag the ROS releases). A high priority for the team is to improve the documentation on the ROS wiki. As we have several releases behind us,
with many packages being actively updated/developed, I am worried that managing the complexity of a single wiki for all versions will become difficult. When it comes to documenting multiple versions, we have two options:
<o:p></o:p></p>
<p class="MsoListParagraph" style="margin-left:.75in;text-indent:-.25in;mso-list:l0 level1 lfo1">
<![if !supportLists]><span style="mso-list:Ignore">1.<span style="font:7.0pt "Times New Roman"">
</span></span><![endif]>Use wiki macros to change content dynamically within a single wiki page.
<o:p></o:p></p>
<p class="MsoListParagraph" style="margin-left:.75in;text-indent:-.25in;mso-list:l0 level1 lfo1">
<![if !supportLists]><span style="mso-list:Ignore">2.<span style="font:7.0pt "Times New Roman"">
</span></span><![endif]>Create new version specific wiki pages (as sub-pages to the package wiki page) and then modify any content that needs to be updated.<o:p></o:p></p>
<p class="MsoNormal">Option 1 allows us to reuse common content. This has been our approach, but I believe this is becoming complex as time(versions) goes on.<o:p></o:p></p>
<p class="MsoNormal">Option 2 makes multiple copies of pages, sometimes with little to no difference between them. However, it is very robust since new modifications do not affect the other ROS versions.<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">I am leaning towards option 2.<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">Does anybody else have these problems? If we start creating a bunch of wiki sub-pages, will this affect the wiki performance (negatively)? It feels like the ROS approach of handling wiki versions at a package level is counter to most
other software documentation (i.e. python <a href="https://docs.python.org/2/">https://docs.python.org/2/</a> &
<a href="https://docs.python.org/2.6/">https://docs.python.org/2.6/</a> ) where versions are captured (and copied) at the root level.<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">Thanks,<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal"><span style="color:#1F497D">Shaun Edwards<o:p></o:p></span></p>
<p class="MsoNormal"><span style="color:#1F497D">Senior Research Engineer<o:p></o:p></span></p>
<p class="MsoNormal"><span style="color:#1F497D">Manufacturing System Department<o:p></o:p></span></p>
<p class="MsoNormal"><span style="color:#1F497D"><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="color:#1F497D"><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="color:#1F497D"><a href="http://robotics.swri.org"><span style="color:blue">http://robotics.swri.org</span></a><o:p></o:p></span></p>
<p class="MsoNormal"><span style="color:#1F497D"><a href="http://rosindustrial.swri.org/"><span style="color:blue">http://rosindustrial.swri.org/</span></a><o:p></o:p></span></p>
<p class="MsoNormal"><span style="color:#1F497D"><a href="http://ros.swri.org/"><span style="color:blue">http://ros.swri.org</span></a><o:p></o:p></span></p>
<p class="MsoNormal"><span style="color:#1F497D"><a href="https://groups.google.com/group/swri-ros-pkg-dev/boxsubscribe"><span style="color:blue">Join the ROS-Industrial Developers List</span></a><o:p></o:p></span></p>
<p class="MsoNormal"><span style="color:#1F497D">Southwest Research Institute<o:p></o:p></span></p>
<p class="MsoNormal"><span style="color:#1F497D">210-522-3277<o:p></o:p></span></p>
<p class="MsoNormal"><o:p> </o:p></p>
</div>
</body>
</html>