Closed Bug 267596 Opened 20 years ago Closed 11 years ago

Text version of docs doesn't disclose link URLs

Categories

(Bugzilla :: Documentation, defect)

Product:
Bugzilla
Component:
Documentation
Version:
2.19
Type:
defect
Priority:
Not set
Severity:
normal

Tracking

()

Status:
RESOLVED WONTFIX

People

(Reporter: justdave, Unassigned)

References

Details

There are a LOT of places in the docs where we have things hyperlinked to
provide context or more information.  A good example is the end-user demo
walk-through, which instructs the user to log into Landfill to test it out.  But
it doesn't explain what Landfill is other than a link (which if you click it, it
goes there, so they figure it out quick).  The PDF version of the docs lists the
links in parentheses after the linked text.  The Text version does not display
them at all.  We should find a way to make the text version show them the same
way the PDF does.  It's using 'lynx -dump' on the HTML version to generate the
text version...  It's quite likely lynx has an option to let you do that.
my version of lynx add references at the end..

sweep:~/tmp$ cat test.html 
<html>
<body>
this is <a href="http://glob.com.au/">a test</a>.
</body>
</html>
sweep:~/tmp$ lynx -dump test.html 

   this is [1]a test.


References

   1. http://glob.com.au/
sweep:~/tmp$ lynx -version
Lynx Version 2.8.5rel.1 (04 Feb 2004)
libwww-FM 2.14, SSL-MM 1.4.1, GNUTLS 1.0.16
Built on linux-gnu Sep 26 2004 12:53:36

Copyrights held by the University of Kansas, CERN, and other contributors.
Distributed under the GNU General Public License.
See http://lynx.isc.org/ and the online help for more information.

See http://www.moxienet.com/lynx/ for information about SSL for Lynx.
See http://www.openssl.org/ for information about OpenSSL.

(In reply to comment #1)
> my version of lynx add references at the end..

Yeah, that's what I just found in the docs for lynx...  and that's ugly for
docs, especially when the resulting document is HUGE.  You don't want the
reference list 60 pages after the number.  makedocs.pl is purposely disabling
this with -nolist on the commandline.

I wonder if there's some other way to generate a text file...  
it's a shame that openjade doesn't have a plain text backend.
(In reply to comment #3)
> it's a shame that openjade doesn't have a plain text backend.

actually, it does.  'docbook2txt'.  but it chokes severely on our xml...
*** Bug 267587 has been marked as a duplicate of this bug. ***
It's a matter of finding the right .xsl for this kind of processing (or .dsl for
that matter) and use that instead.
From a conversation with justdave, he wants to move the docs to being generated
by xmlto - whose text output appears to include links where they are meant to be
(but without a specific reference in the documentation, I can't tell)
QA Contact: mattyt-bugzilla → default-qa
The same problem occurs with the TXT output of the new reST docs, but we are now no longer linking to plain text on www.bugzilla.org. The options are HTML, Zipped HTML, PDF and ePub (the last 3 of which cover the offline use case). So I'd say this is WONTFIX.

Gerv
Status: NEW → RESOLVED
Closed: 11 years ago
Resolution: --- → WONTFIX
You need to log in before you can comment on or make changes to this bug.