Bug 415468 - misformatted okular man page
Summary: misformatted okular man page
Status: RESOLVED FIXED
Alias: None
Product: okular
Classification: Applications
Component: general (show other bugs)
Version: 1.9.0
Platform: Arch Linux Linux
: NOR normal
Target Milestone: ---
Assignee: Okular developers
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2019-12-23 05:19 UTC by rushikeshjogdand1
Modified: 2019-12-24 10:12 UTC (History)
4 users (show)

See Also:
Latest Commit: https://invent.kde.org/kde/okular/commit/feb72a016fac45316e5e569ef8523e370186a284
Version Fixed In:
rushikeshjogdand1: corner_case+

Attachments
Add an attachment

Note You need to log in before you can comment on or make changes to this bug.
Description rushikeshjogdand1 2019-12-23 05:19:30 UTC 
SUMMARY
misformatted okular man page

STEPS TO REPRODUCE
1. open manual (man okular)

OBSERVED RESULT
"Okular Options" section shows unprocessed macros. The indentation is misformatted. This is because of space before the macro commands.

```
.SH "OKULAR OPTIONS"

  .PP
\fB\-p, \-\-page \fR\fB\fInumber\fR\fR
.RS 4
  
Open a given page in the document\&.
  
  .RE
  .PP
\fB\-\-presentation\fR
.RS 4
```

EXPECTED RESULT
Proper indentation. Macros performing their actions instead of rendering on man page.


SOFTWARE/OS VERSIONS
okular: 1.9.0

ADDITIONAL INFORMATION
This bug can be resolved if unnecessary whitespace in doc/man-okular.1.docbook (source) is removed. However, I'm not sure if this is the right file to be changed since whitespace between XML elements is not considered significant. (I guess..?)
Comment 1 Oliver Sander 2019-12-23 05:47:08 UTC 
Looks okay on my system (Okular from git master).  The file 'okular.1' which you are (presumably) looking at is auto-generated from a docbook file.  Are you sure you didn't manually change the indentation by accident?
Comment 2 rushikeshjogdand1 2019-12-23 11:16:30 UTC 
@Oliver, The file is part of gunzipped /usr/share/man/man1/okular.1.gz from Arch Linux package extra/okular 19.12.0-1 .

I also built from master and still the problem persists.

It may have to do with some package version used on Arch Build- on my machine as well as the packager.

Following are the software versions on my system, that I think maybe related to the issue :

extra/kdoctools 5.65.0-2
extra/docbook-xsl 1.79.2-5
Comment 3 Antonio Rojas 2019-12-23 14:41:04 UTC 
This happens when compiling with namespaced stylesheets.

Fix in https://phabricator.kde.org/D26190
Comment 4 Antonio Rojas 2019-12-23 17:32:04 UTC 
Git commit 9ac31982c5ca2bbcf75e067004061a7015e70f20 by Antonio Rojas.
Committed on 23/12/2019 at 17:31.
Pushed by arojas into branch 'master'.

Fix man page formatting

Remove indentation that breaks formatting when compiling with namespaced stylesheets.

Differential Revision: https://phabricator.kde.org/D26190

M  +51   -44   doc/man-okular.1.docbook

https://invent.kde.org/kde/okular/commit/9ac31982c5ca2bbcf75e067004061a7015e70f20
Comment 5 Albert Astals Cid 2019-12-24 10:12:34 UTC 
Git commit feb72a016fac45316e5e569ef8523e370186a284 by Albert Astals Cid, on behalf of Antonio Rojas.
Committed on 24/12/2019 at 10:12.
Pushed by aacid into branch 'release/19.12'.

Fix man page formatting

Remove indentation that breaks formatting when compiling with namespaced stylesheets.

Differential Revision: https://phabricator.kde.org/D26190

(cherry picked from commit 9ac31982c5ca2bbcf75e067004061a7015e70f20)

M  +51   -44   doc/man-okular.1.docbook

https://invent.kde.org/kde/okular/commit/feb72a016fac45316e5e569ef8523e370186a284