search

serlo / serlo-export

Export Serlo.org and Mathe für Nicht-Freaks articles into various output formats
https://de.serlo.org/
Apache License 2.0
5 stars 1 forks source link

design: semantic boxes #65

Closed elbotho closed 7 years ago

elbotho commented 7 years ago

Semantic boxes have the same indentation and blue bar as #62. I will decide on and create the icons later.

Mockup

image

elbotho commented 7 years ago

I will probably use Icons from the Font Awesome Iconfont. So if using another font is easier, we could just go with that.

Download at http://fontawesome.io/

Lodifice commented 7 years ago

This was huge, see #71. Once it is merged and the icons are ready, I will include them and close this issue.

There is a dummy graphics for theorems, we can easily add graphics for all boxes.

Also note #70. It is probably the easiest to use glyphs and place them left to the space between box title and box content.

Lodifice commented 7 years ago

This is merged into master. No I wait for your decision on icons, @elbotho - graphics or glyphs? A dummy example would be enough to play with. Then I can close this issue and we can open a new one for missing icons (similar to #55)

elbotho commented 7 years ago

@Lodifice let's do it with the font. I strongly suspect we will find all the icons we need there. SVG or Icon Font -> the one that is easier to implement.

Lodifice commented 7 years ago

Added a dummy example with FontAwesome icons for the proof environment. Now you can compare ;)

Both approaches have an issue, however. Graphics: see #70 Fonts: compare proofs with and without title - the placement of the symbol is fixed below the frametitle, so the two cases look different.

elbotho commented 7 years ago

@Lodifice Are you waiting for my input here? Or did you mean a different issue? Is it in @kulla current upload? (otherwise I can't check it atm.)

Lodifice commented 7 years ago

@elbotho yes I was talking about this one. It's on the decision fonts vs graphics and if the vertical position of the font icon would be an issue.

I'll send you a beispielbuch to make sure^^

elbotho commented 7 years ago

Yes the placement is indeed an issue. The placement in the "Beweis ohne Titel" example is good. If there is no fix for this I's prefer SVG icon with the correct position.

About the LaTeX stuff: You can also ask Jonas (inyono on slack) maybe he has an idea.

Lodifice commented 7 years ago

We can also have a font icon placed like the SVG. It's rather "page break issue" vs. "placing issue".

So I would prefer independent decisions:

  1. Font or graphics?
  2. startcode or startinnercode? (and find a solution for the corresponding issue)
elbotho commented 7 years ago

Yeah, good separation.

  1. If there are no annoying technical problems, let's go with SVG-Icons (graphics) for flexibility
  2. (don't have input here)
elbotho commented 7 years ago

there is still discussion going on about the icons. but you can go ahead and create it with a standard icon, I or we can just replace the files later.

elbotho commented 7 years ago

Looking at the current export I have some observations. Can of course be discussed.

Lodifice commented 7 years ago

Switched to images in 01232e5bd0de95349f390b36813863825d17f564. There is now an icons directory with dummy pngs which you can replace individually.

However, I cannot get placements to work. If you know any Latex freaks please ask them. Otherwise I do not see icons in 1.0 (currently I commented them out)...

To you other points @elbotho:

The kind of box should only show on the more important boxes (e.g. Satz) or when there is a Title present. Otherwise the icons should be enough and hopefully self explanatory.

This can be configured in the template for box type, otherwise Python code would be necessary. If we don't show the images if no title is present, the startinnercode approach would work nicely. However, most of the semantic boxes do not have titles and therefore would not have an icon...

We should add a legend to explain the the different icons and boxes

I think they are self-explanatory, because the title is in every box. Other opinions?

There should never be nested boxes. If it needed for comprehension please tell me.

If you see nested boxes, it is a bug. Please tell us then :D

When a Beweis is Part of a Satz the title should not be repeated (at least if it's the same)

No opinion.

Maybe we need a minimal height for boxes so the Icons don't overreach?

I think if we go for slightly smaller icons, which we should do, we have 3 x 12 pt at least (box title, empty line, theorem title) which should be sufficient.

elbotho commented 7 years ago

For the minimal height I was referring to cases like this:

image

Not sure what kind of box that is though.

elbotho commented 7 years ago

New icons via 3eafbf2ec3eee1730bfe43eee647e74e2e7734f9 and 8f694ae329cae7be1191d13db6af29b9c902c90a

Lodifice commented 7 years ago

Regarding the minimal height: that is an important paragraph which does not have an icon.

Icons should be ok since 247b8da6f05e7b67bf84c110442e79731ccb8a9c, or do you want me to change the placing?

Lodifice commented 7 years ago

This has come to a happy end after 8c0a787e648e41cfa6e45d783e88d9793f0102c5 ;)