283460 - Clean up internal links on LDAP C SDK documentation

Status: RESOLVED FIXED

(www.mozilla.org :: General, defect, P2)

Description

[Simon Paquet [:sipaq]]

As said in bug 274417 comment 1 we should replace the internal links, which use
a numbering scheme of xyz.html#1002345, with a more sensible naming scheme.

Some work was already done for this on Chapter 6 of the LDAP C SDK documentation
(see http://www.mozilla.org/directory/csdk-docs/controls.htm) but more work is
needed.

Comment 1

[Simon Paquet [:sipaq]]

Today I did some minor cleanup work on index.htm. I did a total cleanup of
preface.htm and all links to this document.

Comment 2

[Simon Paquet [:sipaq]]

All links to extendop.htm have been cleaned up.

Comment 3

[Simon Paquet [:sipaq]]

All links to example.htm, sasl.htm and compare.htm have been cleaned up.

Comment 4

[Simon Paquet [:sipaq]]

All links to ssl.htm have been cleaned up.

Comment 5

[Simon Paquet [:sipaq]]

All links to filter.htm have been cleaned up.

Comment 6

[Simon Paquet [:sipaq]]

All links to url.htm have been cleaned up.

Comment 7

[Simon Paquet [:sipaq]]

All links to getstart.htm have been cleaned up.

Comment 8

[Simon Paquet [:sipaq]]

All links to threaded.htm have been cleaned up.

Comment 9

[Simon Paquet [:sipaq]]

All links to controls.htm have been cleaned up.

Comment 10

[Simon Paquet [:sipaq]]

All links to ldap.htm and srvrinfo.htm have been cleaned up.

Comment 11

[Simon Paquet [:sipaq]]

All links to writing.htm have been cleaned up.

Comment 12

[Simon Paquet [:sipaq]]

I think I might as well take this bug, if I'm doing all the work :-)

Comment 13

[Simon Paquet [:sipaq]]

All links to error.htm and datatype.htm have been cleaned up.

Comment 14

[Simon Paquet [:sipaq]]

using.htm has been cleaned up.

The three biggest files in the directory:

- search.htm
- addmod.htm
- function.htm

are still outstanding. Any help is appreciated.

Comment 15

[Anne (:annevk)]

There is a problem with the patches. You are not following the Documentation
Guidelines:
 <http://www.mozilla.org/contribute/writing/guidelines#linking>

search.htm has had some cleanup by the way.

Comment 16

[Simon Paquet [:sipaq]]

(In reply to comment #15)
> There is a problem with the patches. You are not following the Documentation
> Guidelines:
>  <http://www.mozilla.org/contribute/writing/guidelines#linking>
> 
> search.htm has had some cleanup by the way.

1. The documentation guidelines are bogus in this respect especially the
following part: 

"Use <a name="anchor-name">.  Linking to an ID isn't supported in many browsers.
Also, anchors should, like filenames, be lower case."

See http://python.fyxm.net/dev/doc/idtest.html

2. Yes, search.htm has had some cleanup by you (and I'm grateful for that), but
not all links pointing to search.htm have been cleaned up.

3. Search.htm has now been cleaned up totally (including all links to that document)

Comment 17

[Anne (:annevk)]

I didn't meant the usage of NAME. Sorry about that. Using ID is perfectly fine,
especially for developer documentation. However, using underscores is incorrect.

Comment 18

[Simon Paquet [:sipaq]]

addmod.htm has also been cleaned up, now without underscores.

Comment 19

[Simon Paquet [:sipaq]]

Ok, function.htm and all files linking to it have now also been cleaned up. This
bug is now FIXED. Yay!