Skip to content

Couple of improvements for generated PDF #1342

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.

Sign up for GitHub

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

Jump to bottom
Closed
3 of 4 tasks
ViralBShah opened this issue Jun 16, 2020 · 6 comments
Closed
3 of 4 tasks

Couple of improvements for generated PDF #1342

ViralBShah opened this issue Jun 16, 2020 · 6 comments
Assignees
@fredrikekre
Labels
Format: LaTeX Related to the LaTeX / PDF output Type: Enhancement

Comments

@ViralBShah
Copy link
Contributor

ViralBShah commented Jun 16, 2020 •
edited
Loading

In the PDF of the Julia manual (and presumably all PDFs), it would be nice to have:

  • Slightly more space for the chapter and section numbers
  • Restricting TOC depth to just Chapter and Section (it goes much deeper) depth controlling argument #1259
  • A way to incorporate the project logo on the title page
  • Start the TOC on the next page (currently starts on the title page)

Related: JuliaLang/julia#35495

80426085-043f4400-88b3-11ea-9b7a-b9cbf5add40b
@mortenpi mortenpi added Format: LaTeX Related to the LaTeX / PDF output Type: Enhancement labels Jun 16, 2020
@ViralBShah
Copy link
Contributor Author

ViralBShah commented Jun 17, 2020 •
edited
Loading

The memoir documentclass also creates more of a printable book, but perhaps we should just use article. I am sure that almost nobody prints this PDF, and it is largely for screen reading.

@fredrikekre fredrikekre self-assigned this Jun 17, 2020
inkydragon added a commit to inkydragon/Julia-LaTeX-doc that referenced this issue Jun 26, 2020
@inkydragon
[demo] workaround
363d14c 
xref: JuliaDocs/Documenter.jl#1342

fix 1. & 2.
@inkydragon
Copy link

I've done some experimenting, see https://github.com/inkydragon/Julia-LaTeX-doc.
Here is the output PDF TheJuliaLanguage-en-[4 over 4]-1c28e22.pdf.

Instead of submitting a pull request, I put them in a separate project.
Because I'm not sure if these style changes should be applied to Documenter.jl which will affect all packages.
Maybe we should have some separate LaTeXWriter.jl for the julia's document.

I also made a title page design, which imitates the https://julialang.org/.
Welcome to provide a better design scheme. A sketch with a little explanation is enough.

image

@ViralBShah
Copy link
Contributor Author

Right now, it is all part of Documenter, and applies to all projects. So we would need to have some capabilities that extend Documenter to allow for this.

@mortenpi
Copy link
Member

That looks really good. A bunch of the (general) style fixes (e.g. the TOC numbers, not doing the left/right page thing) should be incorporated into Documenter I'd say. Stuff that is specific to the Julia manual I would put into the Julia repository.

LaTeXWriter would need to be extended a little bit to support the logo and background image on the title page. But it does not have to be super sophisticated / generic. Something like being able to override the raw LaTeX source of the title page in the makedocs call would already be sufficient.

jebej added a commit to jebej/Documenter.jl that referenced this issue Feb 12, 2021
@jebej
A few PDF improvements
c27df5c 
Ref: JuliaDocs#1342 

1. Use the `oneside` option of the memoir class, which is better for reading on a screen and anything that isn't a bound book.
2. For now hardcode ToC depth to section.
3. Clear page after the title.
@jebej jebej mentioned this issue Feb 12, 2021
Merged
mortenpi added a commit that referenced this issue Feb 15, 2021
@mortenpi
A few PDF improvements (#1527)
f7c7929 
Ref: #1342

1. Use the `oneside` option of the memoir class, which is better for reading on a screen and anything that isn't a bound book.
2. For now hardcode ToC depth to section.
3. Clear page after the title.
mortenpi added a commit that referenced this issue Feb 15, 2021
@mortenpi
A few PDF improvements (#1527)
083f592 
Ref: #1342

1. Use the `oneside` option of the memoir class, which is better for reading on a screen and anything that isn't a bound book.
2. For now hardcode ToC depth to section.
3. Clear page after the title.

(cherry picked from commit f7c7929)
@odow
Copy link
Collaborator

odow commented Sep 16, 2022

I think these four points are all done (1, 2, and 4 are, 3 needs a custom preamble). Is there anything still actionable?

image

@ViralBShah
Copy link
Contributor Author

Yes, this is done, and we decided to leave the depth as is.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@fredrikekre fredrikekre

Labels
Format: LaTeX Related to the LaTeX / PDF output Type: Enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@mortenpi @ViralBShah @inkydragon @odow @fredrikekre