[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-i18n-doc
Subject:    Fwd: RFC: include SGML-/Snapshot-links in docs
From:       Eric Bischoff <ebisch () cybercable ! tm ! fr>
Date:       1999-11-26 20:15:44
[Download RAW message or body]

Hi all,

I submit this message here for discussion.

I'm not completely in favour of the following ideas, for maintenance reasons,
but they are at least worth discussing them.

(to Andreas : thanks for your contribution ! We'll see what comes out of it.)

----------  Message réacheminé  ----------
Subject: RFC: include SGML-/Snapshot-links in docs
Date: Wed, 24 Nov 1999 19:52:18 +0100
From: Andreas Schlapbach <schlpbch@bluewin.ch>

Dear Eric

As you seem to be involved in the KDE documentation (you post
doc-related stuff to kde-devel), let me propose two modifications to the
structure of the documents.

- Include a link to the sgml file of a document

The reason is this: First, if a document is split up in numerous
html-files, it's a real pain printing it. If there would be a link, one
could just download the sgml-file, convert it to PS and print it. It
would also help reducing phone bills, because getting one sgml-files is
easier then getting all html-files..

- Include a link to the latest snapshot of the program documented.

I know that KDE is working with CVS, but I spent hours trying to figure
out where to get one and only program (which tar ball? which
directory?). It would also be confinend, if there was a possibility to
download just the files needed (say kppp) than the whole tar ball
(kdenetworks). An automatic check out from the CVS-server would be
handy. But there should at least be a _working_ link to the latest
snapshot.

If this could be made standard, this would help improving the
user-friendlyness of KDE, reduce the noise to KDE mailing lists and help
getting new users/hackers involved. It would be in the interest of all,
to somehow force people writing docs/programs to stick to this.

Example:

..
<<sect>Copyright<p>


Kset Copyright 1999 Andreas Schlapbach , <htmlurl
url="mailto:schlpbch@iamexwi.unibe.ch" name="schlpbch@iamexwi.unibe.ch">

This document can be found <htmlurl url="..." name="here">
The newest snapshot ist available <htmlurl url".." name="here">


May be, your not the right person to decide this, but I'm sure you know
who is.
---------------------------
Eric Bischoff
KDE documentation coordinator
--
 __________________________________________________
                                           \^o~_.
     .~.                           ______  /( __ )
     /V\         Toys story         \__  \/  (  V
   //   \\                            \__| (__=v
  /(     )\                        |\___/     )
    ^^-^^                           \_____(  )
     Tux                    Konqui         \__=v
 __________________________________________________
 Eric Bischoff   -   mailto:ebisch@cybercable.tm.fr

[prev in list] [next in list] [prev in thread] [next in thread]