[Samba] documentation bug?

[Mariano Absatz]

Hi,

I'm thoroughly RTFM'ing in order to find out what I'm doing wrong
<http://lists.samba.org/archive/samba/2009-October/thread.html#151046>
and I noticed that links from the *Samba-HOWTO-Collection* to the
*manpages-3* don't work... the problem is that both documentation sets
are on different directories but links don't include a path (nor
absolute, nor relative).

IIRC, this was working fine a couple of months ago, so I guess the pages
are being re-ordered.

This is just to let you know this should be fixed.

e.g. in
http://samba.org/samba/docs/man/Samba-HOWTO-Collection/NetworkBrowsing.html
where it says:

<div class="itemizedlist"><ul type="disc">
<li><a class="link" href="smb.conf.5.html#OSLEVEL <view-source:http://samba.org/samba/docs/man/Samba-HOWTO-Collection/smb.conf.5.html#OSLEVEL>" target="_top">os level</a></li>
<li><a class="link" href="smb.conf.5.html#LMANNOUNCE <view-source:http://samba.org/samba/docs/man/Samba-HOWTO-Collection/smb.conf.5.html#LMANNOUNCE>" target="_top">lm announce</a></li>
<li><a class="link" href="smb.conf.5.html#LMINTERVAL <view-source:http://samba.org/samba/docs/man/Samba-HOWTO-Collection/smb.conf.5.html#LMINTERVAL>" target="_top">lm interval</a></li>
<li><a class="link" href="smb.conf.5.html#PREFERREDMASTER <view-source:http://samba.org/samba/docs/man/Samba-HOWTO-Collection/smb.conf.5.html#PREFERREDMASTER>" target="_top">preferred master</a>(*)</li>
<li><a class="link" href="smb.conf.5.html#LOCALMASTER <view-source:http://samba.org/samba/docs/man/Samba-HOWTO-Collection/smb.conf.5.html#LOCALMASTER>" target="_top">local master</a>(*)</li>
<li><a class="link" href="smb.conf.5.html#DOMAINMASTER <view-source:http://samba.org/samba/docs/man/Samba-HOWTO-Collection/smb.conf.5.html#DOMAINMASTER>" target="_top">domain master</a>(*)</li>
<li><a class="link" href="smb.conf.5.html#BROWSELIST <view-source:http://samba.org/samba/docs/man/Samba-HOWTO-Collection/smb.conf.5.html#BROWSELIST>" target="_top">browse list</a></li>
<li><a class="link" href="smb.conf.5.html#ENHANCEDBROWSING <view-source:http://samba.org/samba/docs/man/Samba-HOWTO-Collection/smb.conf.5.html#ENHANCEDBROWSING>" target="_top">enhanced browsing</a></li>
</ul></div>

it should say something like this:

<div class="itemizedlist"><ul type="disc">
<li><a class="link" href="../manpages-3/smb.conf.5.html#OSLEVEL" target="_top">os level</a></li>
<li><a class="link" href="../manpages-3/smb.conf.5.html#LMANNOUNCE" target="_top">lm announce</a></li>
<li><a class="link" href="../manpages-3/smb.conf.5.html#LMINTERVAL" target="_top">lm interval</a></li>
<li><a class="link" href="../manpages-3/smb.conf.5.html#PREFERREDMASTER" target="_top">preferred master</a>(*)</li>
<li><a class="link" href="../manpages-3/smb.conf.5.html#LOCALMASTER" target="_top">local master</a>(*)</li>
<li><a class="link" href="../manpages-3/smb.conf.5.html#DOMAINMASTER" target="_top">domain master</a>(*)</li>
<li><a class="link" href="../manpages-3/smb.conf.5.html#BROWSELIST" target="_top">browse list</a></li>
<li><a class="link" href="../manpages-3/smb.conf.5.html#ENHANCEDBROWSING" target="_top">enhanced browsing</a></li>
</ul></div>

Another (minor) issue is that links like the ones above land in the
content of the item, but the title (the item name) lands above the
browser window and (IMHO) this is a bit confusing...

That is, if I click on the first item in the list I see the explanation
of the *os level* config setting, but I don't see the *os level* title
right above it... this can be corrected (if desired, of course) on the
target page (where the *<a name="xxxx"></a>* tag is generated).

That is, instead of generating:

<div class="section" lang="en"><div class="titlepage"><div>
<div><h3 class="title"><a name="id2553774"></a>
os level (G)
</h3></div></div></div>
<a class="indexterm" name="id2553776"></a><a name="OSLEVEL"></a>
<div class="variablelist"><dl><dt></dt><dd><p>
	This integer value controls what level Samba advertises itself as for browse elections. The value of this
...

generate the following:

<div class="section" lang="en"><div class="titlepage"><div>
<a class="indexterm" name="id2553776"></a><a name="OSLEVEL"></a>
<div><h3 class="title"><a name="id2553774"></a>
os level (G)
</h3></div></div></div>
<div class="variablelist"><dl><dt></dt><dd><p>
	This integer value controls what level Samba advertises itself as for browse elections. The value of this
...


This is a minor issue but I think would be more useable...

-- 
Mariano Absatz - "El Baby"
el.baby at gmail.com
www.clueless.com.ar


-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
"A system admin's life is a sorry one. The only
advantage he has over Emergency Room doctors is that
malpractice suits are rare. On the other hand, ER
doctors never have to deal with patients installing new
versions of their own innards!"
           -- Michael O'Brien
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
* TagZilla 0.066 * http://tagzilla.mozdev.org