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

Fix note icon, UL marker size, dot-leader #345

Closed
wmat opened this issue Jun 7, 2024 · 37 comments · Fixed by #346
Closed

Fix note icon, UL marker size, dot-leader #345

wmat opened this issue Jun 7, 2024 · 37 comments · Fixed by #346

Comments

@wmat
Copy link
Contributor

wmat commented Jun 7, 2024

Revert the note admonition icon to the older info circle.
Make unordered lists bullets larger.
Add the TOC dot-leader back in.

@ved-rivos
Copy link
Collaborator

Change codespan font to Jetbrains mono.

@ved-rivos
Copy link
Collaborator

Make page number column in TOC fixed width so the column does not look wavy.
Make Figure number and Table number column in list of figures and list of tables fixed width so that captions line up and dont look wavy. Perhaps something like below:

# List of figures settings
lof:
  label_width: '3em'  # Adjust the width for figure labels
  align: left
  caption:
    indent: '4em'  # Ensure captions align consistently

# List of tables settings
lot:
  label_width: '3em'  # Adjust the width for table labels
  align: left
  caption:
    indent: '4em'  # Ensure captions align consistently

@wmat wmat linked a pull request Jun 7, 2024 that will close this issue
@ved-rivos
Copy link
Collaborator

Bullets could possible be fixed this way:

# List settings
list:
  indent: '$horizontal_rhythm * 1.5'
  item_spacing: '$vertical_rhythm / 2'
  bullet:
    font_size: 'round($base_font_size * 1.5)'
    content: '•'

@wmat
Copy link
Contributor Author

wmat commented Jun 7, 2024

I'll give that a try.

@wmat
Copy link
Contributor Author

wmat commented Jun 7, 2024

Didn't seem to work.

@ved-rivos ved-rivos reopened this Jun 8, 2024
@wmat
Copy link
Contributor Author

wmat commented Jun 10, 2024

I've fixed the bullets. I have it looking like this now:

Screenshot from 2024-06-10 10-17-51

@ved-rivos
Copy link
Collaborator

That looks good. Thanks!

@ved-rivos
Copy link
Collaborator

how does the level 2 and level 3 sub-bullet look?

@wmat
Copy link
Contributor Author

wmat commented Jun 10, 2024

Here's what all 3 levels look like:

Screenshot from 2024-06-10 11-03-48

@ved-rivos
Copy link
Collaborator

The size and shape look good! Could the second level also have color black instead of white.

@wmat
Copy link
Contributor Author

wmat commented Jun 10, 2024

How's this:
Screenshot from 2024-06-10 11-25-48

@ved-rivos
Copy link
Collaborator

Thanks! Looks good!

@wmat
Copy link
Contributor Author

wmat commented Jun 10, 2024

btw, setting the :bibtex-style: apa, which matches the ISA manuals will fix your bibliography alignment issue.

@ved-rivos
Copy link
Collaborator

I think the LaTex ISA manual - before asciidoc coversion - used to use ieee bibtext style. It would be preferred to use ieee style..
image

@wmat
Copy link
Contributor Author

wmat commented Jun 10, 2024

Ah, OK. This is a known issue with the ieee style in asciidoc. I'll see if there's a resolution.

@ved-rivos
Copy link
Collaborator

@wmat - would you be updating the codespan font as well to something like Jetbrains mono?

@wmat
Copy link
Contributor Author

wmat commented Jun 10, 2024

Yes, I'll do that as well.

@wmat
Copy link
Contributor Author

wmat commented Jun 11, 2024

JetBrainsMono has been added to my docs-resources branch and pointed codespan at it.

As for the Bibliography, it'd be some work to make the ieee formatting match LaTeX. I know this isn't ideal, but I don't think it's warranted right now. Can you live with the layout the way it is?

So what's left for the iommu spec? The alignment of the LoF and LoT?

@ved-rivos
Copy link
Collaborator

Thanks!

As for the Bibliography, it'd be some work to make the ieee formatting match LaTeX. I know this isn't ideal, but I don't think it's warranted right now. Can you live with the layout the way it is?

I think I can live with that.

So what's left for the iommu spec? The alignment of the LoF and LoT?

The two other item I was tracking were

  1. "wavy" numbers column in TOC, LoF, and LoT.
  2. Lining up the caption text to start from same column in LoF and LoT.

@wmat
Copy link
Contributor Author

wmat commented Jun 11, 2024

So if I use JetBrainsMono as the font for lists it's slightly approved, at least for text alignment but I can't seem to get the wavy numbering to go away:

Screenshot from 2024-06-11 13-48-50

@ved-rivos
Copy link
Collaborator

The Jetbrains mono was to help solve the weird ligatures that were being previously produced like this "&". Hopefully updating to Jetbrains fixed that

image

@wmat
Copy link
Contributor Author

wmat commented Jun 11, 2024

Looks like this now:
Screenshot from 2024-06-11 14-04-31

@ved-rivos
Copy link
Collaborator

Thanks! This looks nice! The older one rendered "&" and "~" using really odd characters.

@wmat
Copy link
Contributor Author

wmat commented Jun 11, 2024

OK, great. That screen capture was from my local build btw. I'll make the changes to docs-resources next.

@wmat
Copy link
Contributor Author

wmat commented Jun 11, 2024

The GitHub action build is now using all of these fixes in docs-resources. Should probably close this now and open new issues as you find them.

@ved-rivos
Copy link
Collaborator

One thing I noticed is that the text inside tables is much smaller than the main body text. Was that intentional?

@wmat
Copy link
Contributor Author

wmat commented Jun 11, 2024 via email

@wmat
Copy link
Contributor Author

wmat commented Jun 12, 2024

So table_font_size was changed to 11.5 recently and then overwritten back to 9 with the merging of the two themes. 9 seems a bit small to me. I'm thinking a size of ($base_font_size * 0.9em) would be appropriate. That is the equivalent to 10.35 pt when base font size is 11.5 pt.

@ved-rivos
Copy link
Collaborator

That should work.

@ved-rivos
Copy link
Collaborator

Thanks! That looked good!

@ved-rivos
Copy link
Collaborator

One small nit if its not too hard to fix. I think the bullets are now a bit too big - I believe they are set to 1.5xbase-font - perhaps 1.25xbase-font is more appropriate. I pasted a google doc compared to the current render.
image

@wmat
Copy link
Contributor Author

wmat commented Jun 12, 2024

I actually am just using unicode glyphs. I believe that one is U-26AB. Does this look better? I can hardly see the difference.

Screenshot from 2024-06-12 14-22-32

@wmat
Copy link
Contributor Author

wmat commented Jun 12, 2024

i can't get it to change :/

@ved-rivos
Copy link
Collaborator

Maybe it will respond to a "font-size" tag in ulist?

ulist:
marker:
disc:
content: "\u26ab"
circle:
content: "\u26ab"
square:
content: "\u25a0"
font-family: JetBrainsMono
font-size: ????

@wmat
Copy link
Contributor Author

wmat commented Jun 12, 2024

that's exactly what I tried.

@ved-rivos
Copy link
Collaborator

ved-rivos commented Jun 12, 2024

Maybe U+2022 or U25CF is better?

@ved-rivos
Copy link
Collaborator

I tried a bunch of these and seems like what you have currently is the best among all.

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

Successfully merging a pull request may close this issue.

2 participants