Ferris Technology

[awaitlink]

This fixes #55 🎉

Screenshots

does_not_compile

panics

Note: this is different from the already existing should_panic attribute which is used for testing the code in CI - since some code blocks should panic in CI, but don't always do that when testing locally, and thus they do not need a panicking Ferris.

unsafe

Note: unsafe code is not tinted red, according to the book:

Using unsafe to take one of the four actions (superpowers) just discussed isn’t wrong or even frowned upon.

not_desired_behavior

Progress

• Add Ferris Technology (js, css).
• Add appropriate attributes to code blocks in the book.
• Tooltips on Ferris images.
• Explain what alarmed Ferris means in the Introduction (and make Ferrises link to the explanation).

Unresolved questions/issues

• 1. Do code blocks which are there to show the behavior that will be implemented later in the chapter need to be annotated as not compiling (e.g. in chapters 05, 12, 17, 20)?

• 2. Ferris positioning when there is less than 4 lines of code (sometimes it's ok, but if there is a lot of text below the code block, Ferris is covering part of it):

  Screenshot of the issue

  

• 3. Background colors for each theme. Current:

  • Light: #fff1f1
  • Rust: #fff1f1
  • Coal: #501f21
  • Navy: #501f21
  • Ayu: #501f21

• 4. In dark themes, does_not_compile Ferris' question mark is hard to distinguish from the background.

[awaitlink]

@carols10cents ^ any thoughts?

@aldeka Is there any chance we can get a white outline on the ? in the does_not_compile Ferris? I think it should then be easily distinguishable from the bg in any theme.

[steveklabnik]

This is amazing, thank you so much! I'm sorry it's taken so long to get back to you; I had rustconf and then a vacation. Carol's been on vacation too.

Let's try to fix up these issues and ship this! I'm so excited!

1. Do code blocks which are there to show the behavior that will be implemented later in the chapter need to be annotated as not compiling (e.g. in chapters 05, 12, 17, 20)?

I think leaving it purely as the status at that point is the right call.

2. Ferris positioning when there is less than 4 lines of code (sometimes it's ok, but if there is a lot of text below the code block, Ferris is covering part of it):

Yeah, that's tough. Is there an easy way to maybe, just hide ferris in that case?

3. Background colors for each theme.

I'm happy with whatever you decide looks best.

4. In dark themes, does_not_compile Ferris' question mark is hard to distinguish from the background.

Ah, that's true. Hm. We already have some issues with this kind of thing and other images, so I don't consider it a blocker.

[awaitlink]

Thanks for your reply!

I think I've fixed the second issue, Ferris shouldn't appear on code blocks with <= 4 lines of code anymore.
Regarding the colors, I think we can leave them as is and tweak when and if needed.

So if I understand you correctly, we are ready to merge right?

[steveklabnik]

So if I understand you correctly, we are ready to merge right?

Yup! This looks fantastic! Thank you so much!

[adjoli]

Hello everyone,
I'm helping translate the book into Portuguese and I couldn't understand how to include Ferris images in the code examples. I even downloaded the .css and .js files, but without success. Could someone guide me how to do it?

Should I change anything in these files?

[awaitlink]

@adjoli You need to just add the correct attributes to the code blocks (see the OP of this PR under "Screenshots" for available attributes). You can see how this is done in the English version, or in the changes of this PR.

Regarding the files: looking at your repository (https://github.com/adjoli/rust-book-pt-br), which I assume is the one you're talking about, it looks like you're missing the part of book.toml that actually includes the .css and .js files in your build (in addition to the files themselves which you've already found).

You should add this to book.toml, specifying the correct path to the files if needed:

[output.html]
additional-css = ["ferris.css"]
additional-js = ["ferris.js"]

[adjoli]

Thanks a lot, @u32i64. It works!