path: root/data/doc/sisu/org/bugs/sisu_bugs.org

** bugs :bug:

*** misc, unclassified

**** TODO UNDERWAY (6.0.5) [#B] exclude heading where possible marker '-#' not distinguished from unnumbered heading '~#'

  * ~# is general & means no ocn (for any object to which it is applied)
  * -# is relevant only for 1~ dummy headings & instructs that they should be
    removed from output where possible
  * where -# is used on any other objects, it is treated the same way as ~#

**** TODO [#B] collapsed level work out logic where dummy lev1 heading

  * exclude heading where lev1 '-#'
  * means subsequent headings & text belong to parent heading (of lev1 -#) 1 level up
  * ponder

*** DBT Outstanding bugs -- sisu caught by removal of ruby-dbi

**** TODO ONGOING #746740 [n|u] manpages incomplete

Date: Sat, 03 May 2014 08:45:49 +0200
From: Daniel Baumann <daniel.baumann@progress-technologies.net>
Subject: manpages incomplete
Package: sisu
Version: 5.3.4-1
Tag: upstream
Severity: normal

sisu supports options like --verbose or --no-manifest, but they are not
listed in the sisu manpage.

***** NOTES/COMMENTS

documentation for sisu does lag a bit and has omissions, but I think you will
find that --verbose is documented, and --no-* options are listed under --exc-*
to which there is a pointer --no-manifest works but is actually
--no-links-to-manifest and is listed under aliases --exc-links-to-manifest and
--exc-manifest-links

Will leave bug open as a reminder that updating is necessary and as there are
no doubt numerous issues for which this could be (re)opened

**** TODO #746742 [n|u] please implement --no-metadata similar to --no-manifest

Date: Sun, 13 Apr 2014 16:12:13 +0200
From: Daniel Baumann <daniel.baumann@progress-technologies.net>
Subject: --no-manifest not working anymore
Package: sisu
Version: 5.3.4-1
Severity: wishlist

when running sisu-pdf with --no-manifest, the output (pdf) still
contains the sisu manifest at the end of the document.

Regards,
Daniel

*** DBT Outstanding bugs -- Wishlist items; Unclassified (24 bugs) :debian:dbt:wishlist:

**** TODO [#D] #744352 [w|u] sisu output: aligning margin numbers when using 'code'
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744352>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: 744352@bugs.debian.org
Subject: Re: sisu output: too many margin numbers
Date: Sun, 13 Apr 2014 17:27:10 +0200
retitle 744352 sisu output: aligning margin numbers when using 'code'
severity 744352 wishlist
thanks

sorry, i've looked wrongly at the output, the problem is simply an
aligning issue. it looks like that:

  foo bar.          [1]
                    [2]
  baz

  foo bar baz.      [3]

rather than:

  foo bar.          [1]

  baz               [2]

  foo bar baz.      [3]

Regards,
Daniel

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: too many margin numbers
Date: Sun, 13 Apr 2014 12:28:14 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist

when using the following code:

foo bar.

code{

  baz

}code

foo bar baz.

the result in the output (pdf) is:

foo bar.          [1]
                  [2]
baz               [3]
                  [4]
foo bar baz.      [5]

the '[n]' designates the margin number at the right site of the page.

the problem is that sisu gives margin numbers to *empty* lines, which is
wrong. margin numbers should only be assigned to actual content.

Regards,
Daniel

***** NOTES/COMMENTS

issue with pdf, look again, consider, this is cosmetic, a fix should be found,
but is not striaghtforward alignment issue for code blocks not so easy to fix
in some outputs, have so far ignored this is an issue with other types of text
block as well

reason why this has not been addressed especially with code blocks:
the easiest fix would be to place the numbering at the end of the first line of
a code block however, as it is now, if you copy & paste a block of code you
should get the code if numbering is moved down to the first line, a copy of the
code block will inlcude the extraneous (to the code) object number which is to
my mind a bigger problem

That said re pdf, LaTeX XeTeX are flexible, it may be possible to drop the ocn
at the start of a code block lower on its line so that it is closer to the code
that follows

**** TODO [#C] #744354 [w|u] sisu output: please do not add '<' and '>' around urls

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: please do not add '<' and '>' around links
Date: Sun, 13 Apr 2014 12:28:37 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist

when using urls in sisu like this:

  http://example.org

sisu then creates in the output (pdf) links like this:

  <http://example.org>

Please do not automagically add a '<' and '>' around urls. If the user
wants them, he would add one.

Regards,
Daniel

***** NOTES/COMMENTS

is sisu default behavior,
would need to make configurable
url_visual_delimiters: '<>'
look into later


**** TODO [#B] #744390 [w|u] sisu: empty sections are ignored
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744390>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: sisu: empty sections are ignored
Date: Sun, 13 Apr 2014 17:09:32 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist

if you have the following sisu syntax:

  :B~ foo

  1~ foo1

  foo1.

  1~ foo2

  foo2.

  :B~ bar

  1~ bar1

  1~ bar2

  :B~ baz

  1~ baz1

  1~ baz2

then anything (including and) after ':B~ bar' is ignored entirely.

***** NOTES/COMMENTS

further info, have not yet been able to duplicate,
seemed to work (checked pdf & html (scroll & seg))
was not able to reproduce
will look again

**** TODO [#D] #744395 [w|u] sisu output: half-page title page in landscape output
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744395>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: sisu output: half-page title page in landscape output
Date: Sun, 13 Apr 2014 17:38:03 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist
Tags: upstream

in a4 landscape output, there's always two pages on one page, which is
nice; except for the title page which spans over the whole page.

it would be nice if the first page would be consistent to the same
scheme like the rest of the document - spanning only over the half of
the page.

Regards,
Daniel

***** NOTES/COMMENTS

think about, should be fairly easily done, but am reluctant

note the page numbering in landscape, the two landscape columns are given a single page number
it is really a landscape two column per-page text, provided primarily for screen viewing or
other convenience if found

(many viewers provide two page per screen presentations, which would result in an effect similar to the one requested
the issue I guess might arise in that they are not printable on a single page? ...
but then the current settings are arguably justified)

**** TODO [#C] #744396 [w|u] sisu output: "european" toc indenting
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744396>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: sisu output: "european" toc indenting
Date: Sun, 13 Apr 2014 17:40:53 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist
Tags: upstream

by default, latex uses the following indenting in the TOC:

  1. foo
      1.1 bar1
           1.1.1 baz
      1.2 bar2

there's a latex option that i don't remember off-hand to have the
indenting like it's common in europe:

  1. foo
  1.1 bar1
  1.1.1 baz
  1.2 bar2

it would be nice if sisu could let the used decide which indenting style
to use for TOCs.

Regards,
Daniel

***** NOTES/COMMENTS

will look at: should be possible; requires a configuration option

**** TODO [#C] #744407 [w|u] sisu: possibility to influence content/formating of the title page
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744407>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: sisu: possibility to influence content/formating of the title page
Date: Sun, 13 Apr 2014 18:32:14 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist
Tags: upstream

by default, the title page (in the pdf output) shows @title and @creator.

it would be nice if there would be a possibility to influence the
formatting (e.g. to have the title written in bold), and to have
additional possibilities to influence the content on the title page
(like the date or version, an url, or other text strings).

Regards,
Daniel

***** NOTES/COMMENTS

consider, work on possibly, later

**** TODO [#C] #744409 [w|u] sisu output: urls in code blocks are not linkified
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744409>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: sisu output: urls in code blocks are not linkified
Date: Sun, 13 Apr 2014 18:41:09 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist
Tags: upstream

it would be nice if urls written withiin code{...}code blocks would also
be automatically transformed into a link within the output (html).

Regards,
Daniel

***** NOTES/COMMENTS

consider, so far code blocks are pretty much untouched ... not tampered with,
this could be done though

**** TODO [#C] #744685 [w|u] sisu output: copy&past-able wrapped code blocks
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744685>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: sisu output: copy&past-able wrapped code blocks
Date: Sun, 13 Apr 2014 19:04:01 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist
Tags: upstream

if a line within a 'code{...}code' block is longer and needs to be
wrapped, sisu indicates the wrapping with an 'arrow' (←) symbol, which
is nice.

it would be even nicer if the arrow would not 'selectable', so that when
you mark the line spanning over two lines with your mouse, the arrow is
not selected and thus not copy&pasted.

i don't know how to do this, but it's possible within pdfs, as can be
seen in lots of pdfs in the internet.

Regards,
Daniel

***** NOTES/COMMENTS

find out how and implement, further feedback on appropriate xetex tools welcome

[Note: if can be applied to random characters, use may be of interest for
object numbers as well!]

**** TODO [#C] #744734 [w|u] sisu output: replace all occurences of (C) rather than the first only

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: sisu output: replace all occurences of (C) rather than the first only
Date: Mon, 14 Apr 2014 06:11:13 +0200

Package: sisu
Version: 5.3.4-1
Severity: wishlist
Tags: upstream

if you have a '(C)' in :copyright:, it is automatically replaced with a
copyright symbol, which is nice, however, it sisu does that with the
first occurence only.

so if you use:

 :copyright: (C) john doe<br />(C) jane doe

then the second occurence is not replaced and that combination looks
very ugly. i suggest you replace all occurences of '(C)' to the
copyright symbol automatically.

Regards,
Daniel