Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Manpage lists have too much space between items #4578

Open
Diegovsky opened this issue Apr 23, 2024 · 5 comments
Open

Manpage lists have too much space between items #4578

Diegovsky opened this issue Apr 23, 2024 · 5 comments

Comments

@Diegovsky
Copy link

Here is an example file that reproduces the issue:

= pod(1)
:doctype: manpage
:man-linkstyle: pass:[blue R < >]

== NAME
pod - example manpage thing

== SYNOPSIS
Words 

.List:
* one
* two

.Ordered:
. one
. two

I expected the lines to not contain any lines around them, but it seems that lines are added around every list item. Here's the output of asciidoctor -b manpage pod.adoc -o - | man -l:

POD(1)                                                                    POD(1)

NAME
       pod - example manpage thing

SYNOPSIS
       Words

       List:

       •   one

       •   two

       Ordered:

        1. one

        2. two

                                   2024-04-23                             POD(1)

I expected to see something like this:

POD(1)                                                                    POD(1)

NAME
       pod - example manpage thing

SYNOPSIS
       Words

       List:
       •   one
       •   two

       Ordered:
        1. one
        2. two

                                   2024-04-23                             POD(1)

I tried to see if if was possible to change this behaviour by searching the unordered list page but it only mentions styles there.

If this is inteded behaviour, would it be possible to add a way to change this?

@mojavelinux
Copy link
Member

This is by design for compatibility with the output produced by the DocBook toolchain. I'd be willing to consider adding support for the compact role on the list to reduce the space. However, someone would need to submit the pull request to add that functionality. It's not something I'm going to work on.

Another option is to extend the manpage converter and override the markup that it generates.

@Diegovsky
Copy link
Author

I think overriding the manpage converter is better as it's probably intended for other formats to have more spacing around list items, though, I have no knowledge of Ruby so I'll wait for someone to implement this.

On an unrelated note: this project is awesome and asciidoc is a very nice format, thank you for your work on the project :)

@mojavelinux
Copy link
Member

Thanks for your kind words!

@mojavelinux
Copy link
Member

Let me know what you'd like to do. Like I said, I'd be open to honoring the compact role, but if you'd like to override the converter, then I won't spend time on that proposal now.

@Diegovsky
Copy link
Author

Well, I would certainly love to have a compact role, but I'm not at all experienced in ruby. I would love to help if you think it's doable, though :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants