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

A better online version is published #59

Open
holmesconan opened this issue Aug 14, 2021 · 5 comments
Open

A better online version is published #59

holmesconan opened this issue Aug 14, 2021 · 5 comments

Comments

@holmesconan
Copy link

holmesconan commented Aug 14, 2021

Nice work for all the writers!! Since I am going to write some Linux Kernel Module, I found this new book that explain the new infrastructure in modern Linux Kernel. But I found that the online version feels not good enough. So I spend a week to convert the latex content into a simple yet I think it is better mark language AsciiDoc. The project is based on Antor which is a new writing platform similar to Sphinx. Here is an article that explains why I chosen it.

The content is separated into multiple files which I think is easier to maintain. I hope the latex could also be separated into chapters if you like. But there is a problem that the Github Pages published under my personal domain, I don't known if you like to merge it, or create an organization that place this version under it.
Another problem is that current version of Antora could not generate PDF files, so the latex version could not be replaced. But the underhood AsciiDoc is targeted DocBook whichi could be converted to PDF. So I think this could be resolved later.

@jserv
Copy link
Contributor

jserv commented Aug 14, 2021

Thank @holmescn for working on Antor based reformatting. I would like to consult @fennecJ and @Hsins .

@Hsins
Copy link
Contributor

Hsins commented Aug 14, 2021

Hi @holmescn, I remember @jserv mentioning that he would like to stick to the LaTeX scripts at present. Based on that principle, the LaTeX scripts should not be replaced even though the PDF files could be generated with Antora, but it would be nice to generate different PDF files based on both and then bundle them in release for choosing.

That is to say, all the other formats (HTML, epub, mobi, and so on) should be converted from LaTeX files automatically as possible as it could and we should only edit the LaTeX files for unifying our work. Could you offer the process for converting LaTeX to AsciiDoc format? I think a possible workflow would be like the diagram shown below:

Workflows

(Note that the LaTeX files should be the source files.)

There are three (or more with other tools) approach to handle that. I believe that both AsciiDoc and Markdown are brilliant markup document format for us because we won't have too much modern features to make this book great. Before we decide which workflow to be used, the issue #26 should be resolve first.

As a reminder, some of custom macros like this should be prevent to simplify those workflows. The more custom macros we use, the less scalability we have. Only the make4ht handle those macros well because it totally based on LaTeX engine.

@fennecJ
Copy link
Collaborator

fennecJ commented Aug 15, 2021

I agree with @Hsins
We should only modify latex file and leave other files to be generated automatically.

@holmesconan
Copy link
Author

@Hsins sorry for that in current stage, the AsciiDoc is not fully automatically generated. I just written a simple Python script to split the lkmpg.tex into several tex files and then convert it manually. There are some problem with pandoc since the \sample macro is not convertable. And there is also a diagram that I didn't converted. I will do my best to write a convert script, but I have no idea about the deadline. I thought this issue could be closed until I finished the script.

@Hsins
Copy link
Contributor

Hsins commented Aug 16, 2021

@holmescn Almost the custom macros like \sample and \src are not convertable with pandoc. Just take a break and wait for the chapter splitting issue #26 to be done.

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

4 participants