riscv-non-isa / riscv-iommu

RISC-V IOMMU Specification
https://jira.riscv.org/browse/RVG-55
Creative Commons Attribution 4.0 International
98 stars 17 forks source link

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

Closed wmat closed 5 months ago

wmat commented 5 months ago

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

ved-rivos commented 5 months ago

Change codespan font to Jetbrains mono.

ved-rivos commented 5 months ago

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
ved-rivos commented 5 months ago

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 commented 5 months ago

I'll give that a try.

wmat commented 5 months ago

Didn't seem to work.

wmat commented 5 months ago

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

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

ved-rivos commented 5 months ago

That looks good. Thanks!

ved-rivos commented 5 months ago

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

wmat commented 5 months ago

Here's what all 3 levels look like:

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

ved-rivos commented 5 months ago

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

wmat commented 5 months ago

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

ved-rivos commented 5 months ago

Thanks! Looks good!

wmat commented 5 months ago

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

ved-rivos commented 5 months ago

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 commented 5 months ago

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

ved-rivos commented 5 months ago

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

wmat commented 5 months ago

Yes, I'll do that as well.

wmat commented 5 months ago

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 commented 5 months ago

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 commented 5 months ago

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 commented 5 months ago

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 commented 5 months ago

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

ved-rivos commented 5 months ago

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

wmat commented 5 months ago

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

wmat commented 5 months ago

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 commented 5 months ago

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

wmat commented 5 months ago

I thought that was fixed. I’ll look shortly.

Bill Traynor Documentation Build and Release Engineer RISC-V International

Join us in Munich, Germany at RISC-V Summit Europe https://riscv-europe.org/summit/2024/ from 24-28 June. Be a part of the new wave of European computing innovation!

On Tue, Jun 11, 2024 at 3:23 PM Ved Shanbhogue @.***> wrote:

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

— Reply to this email directly, view it on GitHub https://github.com/riscv-non-isa/riscv-iommu/issues/345#issuecomment-2161457092, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAN6ZH63XJR7DV2NHSNK23ZG5FEFAVCNFSM6AAAAABI7HY7RGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCNRRGQ2TOMBZGI . You are receiving this because you were mentioned.Message ID: @.***>

wmat commented 5 months ago

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 commented 5 months ago

That should work.

ved-rivos commented 5 months ago

Thanks! That looked good!

ved-rivos commented 5 months ago

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 commented 5 months ago

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 commented 5 months ago

i can't get it to change :/

ved-rivos commented 5 months ago

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 commented 5 months ago

that's exactly what I tried.

ved-rivos commented 5 months ago

Maybe U+2022 or U25CF is better?

ved-rivos commented 5 months ago

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