Debian Bug report logs - #155377
rewrite Character style section

version graph

Package: debiandoc-sgml-doc; Maintainer for debiandoc-sgml-doc is Osamu Aoki <osamu@debian.org>; Source for debiandoc-sgml-doc is src:debiandoc-sgml-doc.

Reported by: Osamu Aoki <osamu@debian.org>

Date: Sun, 4 Aug 2002 05:18:05 UTC

Severity: wishlist

Found in version 1.1.11

Reply or subscribe to this bug.

Toggle useless messages

View this report as an mbox folder, status mbox, maintainer mbox


Report forwarded to debian-bugs-dist@lists.debian.org, Ardo van Rangelrooij <ardo@debian.org>, debiandoc-sgml-doc@packages.qa.debian.org:
Bug#155377; Package debiandoc-sgml-doc. Full text and rfc822 format available.

Acknowledgement sent to Osamu Aoki <debian@aokiconsulting.com>:
New Bug report received and forwarded. Copy sent to Ardo van Rangelrooij <ardo@debian.org>, debiandoc-sgml-doc@packages.qa.debian.org. Full text and rfc822 format available.

Message #5 received at submit@bugs.debian.org (full text, mbox):

From: Osamu Aoki <debian@aokiconsulting.com>
To: submit@bugs.debian.org
Subject: <tt><prgn>... and plain text output
Date: Sat, 3 Aug 2002 22:03:33 -0700
Package: debiandoc-sgml-doc
Version: 1.1.11 
Severity: normal

"4.1. Character style" states
...
     `<prgn>' - name of a program or well-known file
          Indicates that the contained text is the name of a program, a
          well-known filename (usually without paths), a function or some
          similar thing which has a name in the computer.

          In output formats where character highlighting and various font
          styles are available this is usually represented by using a
          fixed-width font.  In plain text output formats these names are
          not specially marked at all, as they occur frequently and
          introducing quoting would disrupt the flow of the text.

This is not true.  <prgn>...</prgn> causes `...' in plain text.

Beside, this chapter should be rewritten more conclusively.  This looks
more like design thought :)  I think this is a good design but not good
as a manual.

This section shall be written as:

<sect>Character style

<sect1>&lt;prgn&gt; &mdash; well-known name of a program without paths
<p>
This &lt;prgn&gtprogram-name&lt;/prgn&gt; will be converted to:
<list>
<item>TEXT: <prgn>program-name</prgn> `program-name'
<item>HTML: <prgn>program-name</prgn> program-name in fixed font
<item>PDF:  <prgn>program-name</prgn> program-name in fixed font
<item>PS: <prgn>program-name</prgn> program-name in fixed font
<item>INFO: <prgn>program-name</prgn> ????
</list>

...

<sect1>&lt;em&gt; &mdash; emphasis
<p>
This &lt;em&gttext&lt;/em&gt; will be converted to:
<list>
<item>TEXT: <em>text</em> _text_ 
<item>HTML: <em>text</em> text in italics
<item>PDF: <em>text</em> text  in italic)
<item>PS: <em>text</em> text  in italics
<item>INFO: <em>text</em>  ?????
</list>

... something like this will make it clear.

debiandoc-sgml-doc   (Not much updated.)

Desired=Unknown/Install/Remove/Purge/Hold
| Status=Not/Installed/Config-files/Unpacked/Failed-config/Half-installed
|/ Err?=(none)/Hold/Reinst-required/X=both-problems (Status,Err: uppercase=bad)
||/ Name           Version        Description
+++-==============-==============-============================================
ii  debiandoc-sgml 1.1.11         Documentation for DebianDoc-SGML

debiandoc-sgml
Desired=Unknown/Install/Remove/Purge/Hold
| Status=Not/Installed/Config-files/Unpacked/Failed-config/Half-installed
|/ Err?=(none)/Hold/Reinst-required/X=both-problems (Status,Err: uppercase=bad)
||/ Name           Version        Description
+++-==============-==============-============================================
ii  debiandoc-sgml 1.1.70         DebianDoc SGML DTD and formatting tools
-- 
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+  Osamu Aoki <debian@aokiconsulting.com> @ Cupertino, CA USA         +




Information forwarded to debian-bugs-dist@lists.debian.org, debiandoc-sgml-doc@packages.qa.debian.org:
Bug#155377; Package debiandoc-sgml-doc. Full text and rfc822 format available.

Acknowledgement sent to Ardo van Rangelrooij <ardo@debian.org>:
Extra info received and forwarded to list. Copy sent to debiandoc-sgml-doc@packages.qa.debian.org. Full text and rfc822 format available.

Message #10 received at 155377@bugs.debian.org (full text, mbox):

From: Ardo van Rangelrooij <ardo@debian.org>
To: Osamu Aoki <debian@aokiconsulting.com>, 155377@bugs.debian.org
Cc: control@bugs.debian.org
Subject: Re: Bug#155377: <tt><prgn>... and plain text output
Date: Sun, 4 Aug 2002 09:22:00 -0500
retitle 155377 rewrite Character style section
severity 155377 wishlist
thanks

Hi,

Funny, I just uploaded a new version a couple of days ago which fixes this
description of <prgn>.  See bug #145338.

But you're completely right in that the whole thing needs a rewrite.  But
that's a wishlist, so I'm changing bug report title and severity accordingly.

Thanks,
Ardo

Osamu Aoki (debian@aokiconsulting.com) wrote:
> Package: debiandoc-sgml-doc
> Version: 1.1.11 
> Severity: normal
> 
> "4.1. Character style" states
> ...
>      `<prgn>' - name of a program or well-known file
>           Indicates that the contained text is the name of a program, a
>           well-known filename (usually without paths), a function or some
>           similar thing which has a name in the computer.
> 
>           In output formats where character highlighting and various font
>           styles are available this is usually represented by using a
>           fixed-width font.  In plain text output formats these names are
>           not specially marked at all, as they occur frequently and
>           introducing quoting would disrupt the flow of the text.
> 
> This is not true.  <prgn>...</prgn> causes `...' in plain text.
> 
> Beside, this chapter should be rewritten more conclusively.  This looks
> more like design thought :)  I think this is a good design but not good
> as a manual.
> 
> This section shall be written as:
> 
> <sect>Character style
> 
> <sect1>&lt;prgn&gt; &mdash; well-known name of a program without paths
> <p>
> This &lt;prgn&gtprogram-name&lt;/prgn&gt; will be converted to:
> <list>
> <item>TEXT: <prgn>program-name</prgn> `program-name'
> <item>HTML: <prgn>program-name</prgn> program-name in fixed font
> <item>PDF:  <prgn>program-name</prgn> program-name in fixed font
> <item>PS: <prgn>program-name</prgn> program-name in fixed font
> <item>INFO: <prgn>program-name</prgn> ????
> </list>
> 
> ...
> 
> <sect1>&lt;em&gt; &mdash; emphasis
> <p>
> This &lt;em&gttext&lt;/em&gt; will be converted to:
> <list>
> <item>TEXT: <em>text</em> _text_ 
> <item>HTML: <em>text</em> text in italics
> <item>PDF: <em>text</em> text  in italic)
> <item>PS: <em>text</em> text  in italics
> <item>INFO: <em>text</em>  ?????
> </list>
> 
> ... something like this will make it clear.
> 
> debiandoc-sgml-doc   (Not much updated.)
> 
> Desired=Unknown/Install/Remove/Purge/Hold
> | Status=Not/Installed/Config-files/Unpacked/Failed-config/Half-installed
> |/ Err?=(none)/Hold/Reinst-required/X=both-problems (Status,Err: uppercase=bad)
> ||/ Name           Version        Description
> +++-==============-==============-============================================
> ii  debiandoc-sgml 1.1.11         Documentation for DebianDoc-SGML
> 
> debiandoc-sgml
> Desired=Unknown/Install/Remove/Purge/Hold
> | Status=Not/Installed/Config-files/Unpacked/Failed-config/Half-installed
> |/ Err?=(none)/Hold/Reinst-required/X=both-problems (Status,Err: uppercase=bad)
> ||/ Name           Version        Description
> +++-==============-==============-============================================
> ii  debiandoc-sgml 1.1.70         DebianDoc SGML DTD and formatting tools
> -- 
> +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
> +  Osamu Aoki <debian@aokiconsulting.com> @ Cupertino, CA USA         +
> 
> 

-- 
Ardo van Rangelrooij
home email: ardo@debian.org
home page:  http://people.debian.org/~ardo
GnuPG fp:   3B 1F 21 72 00 5C 3A 73  7F 72 DF D9 90 78 47 F9



Changed Bug title. Request was from Ardo van Rangelrooij <ardo@debian.org> to control@bugs.debian.org. Full text and rfc822 format available.

Severity set to `wishlist'. Request was from Ardo van Rangelrooij <ardo@debian.org> to control@bugs.debian.org. Full text and rfc822 format available.

Changed Bug submitter from Osamu Aoki <debian@aokiconsulting.com> to Osamu Aoki <osamu@debian.org>. Request was from Osamu Aoki <osamu@debian.org> to control@bugs.debian.org. Full text and rfc822 format available.

Send a report that this bug log contains spam.


Debian bug tracking system administrator <owner@bugs.debian.org>. Last modified: Wed Apr 16 04:36:52 2014; Machine Name: beach.debian.org

Debian Bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.