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

Many formatting errors after man page conversion to adoc #3032

Open
hansu opened this issue Jul 17, 2024 · 9 comments
Open

Many formatting errors after man page conversion to adoc #3032

hansu opened this issue Jul 17, 2024 · 9 comments

Comments

@hansu
Copy link
Member

hansu commented Jul 17, 2024

Since #1376 (which makes the man pages being generated from adoc sources, wich is a great improvement!)
some of them have not ben converted correctly.
So please do not update the man pages until they are fixed.

Here is a list of the differences of the man9 man pages:

diff_man9

It's mostly when bold formatting is involved:

diff_classicladder

diff_classicladder 9

Unfortunately due to #3031 it is currently not possible to inspect the new generated man pages on the web site. You only can check this on a local build.

@hansu hansu changed the title Many formatting errors after man poage conversion to adoc Many formatting errors after man page conversion to adoc Jul 17, 2024
@petterreinholdtsen
Copy link
Collaborator

petterreinholdtsen commented Jul 17, 2024 via email

@hansu
Copy link
Member Author

hansu commented Jul 28, 2024

The problem are strings composed of <bold><italic>[<bold>]<regular>
For example
classicladder.0.in-NN IN bit::
should be
**classicladder.0.in-**_NN_ IN bit::
but was converted like this
*classicladder.0.in-*_NN_ IN bit::

Also some asteriskes appeared before the double colon

See here the fix for the first man pages: https://github.com/LinuxCNC/linuxcnc/pull/3045/files

@petterreinholdtsen maybe we can fix this by applying an intelligent regular expression on it?

@hansu
Copy link
Member Author

hansu commented Jul 28, 2024

@petterreinholdtsen
Copy link
Collaborator

petterreinholdtsen commented Jul 28, 2024 via email

@hansu
Copy link
Member Author

hansu commented Jul 28, 2024

Feel free to try.

I was hoping you can help with your expertise ;-)

I used pandoc to do the conversion, and hoped it
would do a good enough job. :)

It seems that pandoc has some problems with the inline formatting. Maybe you can report that?

@hansu
Copy link
Member Author

hansu commented Jul 29, 2024

@petterreinholdtsen I have now fixed a few man pages and I think you could also fix some.

Otherwise I tend to revert the converted man pages because the goal was to simplify the maintenance of the man pages and not to introduce a huge amount of work to fix the errorneous converted man pages.

@andypugh
Copy link
Collaborator

andypugh commented Aug 3, 2024

Is this fixed now?
http://linuxcnc.org/docs/stable/html/man/man9/classicladder.9.html
Looks OK to me.

@hansu
Copy link
Member Author

hansu commented Aug 3, 2024

50% of the man9 pages are fine (double checked), the rest probably as well.

But you can't check it this way unfortunately because of #3031

@smoe
Copy link
Contributor

smoe commented Aug 17, 2024

I think we are mostly stuck with the man pages PRs of mine still failing on sid.

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

No branches or pull requests

4 participants