grimbough / msmbstyle

Tufte inspired bookdown template
https://www-huber.embl.de/users/msmith/msmbstyle/
59 stars 17 forks source link

Footnote on list item formatted incorrectly #8

Open aridus opened 5 years ago

aridus commented 5 years ago

With msmbstyle, if one adds a footnote to a list item the footnote in the right hand column is aligned too far to the left (i.e. it does not left align with other items in the column).

This code illustrates the problem:

`- Literature citations do not have matching references, and vice versa.^[Solution: use a [reference manager][Reference management].]

Literature citations and references are not in the journal's preferred format.^[Solution: use a [reference manager][Reference management].] `

Would it be possible for this to be fixed?

With grateful thanks!

grimbough commented 5 years ago

I think I've sorted this in the CSS file now. Try installing version 0.0.7 and see if the update works for you too.

aridus commented 5 years ago

Many thanks for being responsive! I have installed 0.0.7. It has caused a change but perhaps not that expected. I have shared three screenshots at

https://www.dropbox.com/sh/4rb2grhr1l0z19j/AACLYfqSEkvOoh-TF7bUhC4Fa?dl=0

Screenshot_zero shows the footnotes on a list

Screenshot_one shows the footnotes on a blockquote

Screenshot_two shows that a piece of text on {marginfigure}, which formally was correctly aligned left, is now in the wrong position.

I would be happy to test further to help you resolve this issue.

With warm regards.

grimbough commented 5 years ago

Thanks for the screen shots. I wouldn't have expected the block quote to change as I only modified the CSS for margin notes inside lists, but it shouldn't have broken the 'standard' margin text.

Any chance you can put the examples in a single Rmd file for me to compile? Then I can make sure I'm constructing them in the same way you are.

aridus commented 5 years ago

Thank you: this seems like a good idea, in case I am doing anything silly - always a possibility. I have uploaded to the same folder 'structure (copy).Rmd'. I have deleted graphics, so that it should compile fine (but let me know if not).

Thanks again.

grimbough commented 5 years ago

Thanks for that. I hadn't really defined the blockquote environment at all, so it was just falling back on whatever the browser default is. I think this is sorted now, so feel free to give it a test.

aridus commented 5 years ago

Thank you, again, and all is now well!

As an aside, could the blockquote environment benefit from better definition? At present the text is simply indented (there is no grey background or other indication).

In the bookdown manual at https://bookdown.org/yihui/bookdown/markdown-syntax.html, below the text 'The actual output (we customized the style for blockquotes in this book):' a blockquote has a light grey bar on the left-hand side, and if one narrows the page scrollbars do not appear (as they do on a code chunk). I think this behaviour (light grey bar, no scroll bars) works very well and would like to see it in msmbstyle.

I am using msmbstyle to prepare two instruction manuals, and it is working well, so thank you for your efforts. The manuals will go live sometime in April. I can send you a link if you wish.

The only matter I am struggling with is how to tailor the top bar and menu so that these items fit in with our website (but this is down to my extremely rudimentary knowledge of css).

Yours, etc.

grimbough commented 5 years ago

Yes, I agree. At the moment msmbstyle is just piggy-backing on the tufte package, and that seems to define block quote as a simple indentation, which doesn't seem in the spirit of how blockquote is supposed to be used. I'll have a look at some examples and maybe refine it a bit, but I'll try to keep the side notes inline when I do!

Feel free to ask questions / make suggestions about the CSS, it's not my forte either. Glad you're finding the package useful, and I'd be very excited to see it used elsewhere in the wild.

aridus commented 5 years ago

Many thanks, and I look forward to news!

Bookdown + tufte style is an unbeatable combination for a teaching tool, and msmbstyle provides several improvements over the original bookdown implementation, hence my enthusiasm for it.

I'm sure I will have other questions. I will be in touch.

Yours, etc.

aridus commented 5 years ago

Just to let you know: marginal footnotes on a list are still slightly out of line. I see this in the following example:

`There are a few cases in which it is reasonable to use acronyms:

  1. Some are now widely known---and often used in preference to the full name---that it seems reasonable to use them, but indicating their expansion at first use^[e.g. CBD for Convention on Biological Diversity{target="_blank"}]. As most readers will have encountered the acronym in other writing, the first use reminds them and they will not be burdened by its repetition in the text.

  2. Some are both widely known and used in everyday speech and writing to the extent that they function almost as replacement names^[e.g. IUCN for International Union for Conservation of Nature{target="_blank"}]. In such rare cases, the expansion of the acronym is unnecessary even at first use.

By convention, abbreviations and acronyms are always expanded at the begninng of a sentence, even if they have been used earlier in the text, as here:`

You can also see the problem at 6.3 in https://www-huber.embl.de/msmb/Chap-Testing.html

Thanks for your attention.

aridus commented 5 years ago

Hi - This is just to ask whether you have any further thoughts on this.

With grateful thanks!

grimbough commented 5 years ago

Is this still an issue? To my eyes it looks fine, but I'm happy to believe it it's some thing that works with my screen resolution/browser/fonts combo, but doesn't for you.

Here's a screen shot with a file browser put on top so I can check the alignment. The first footnote is from a normal paragraph, the bottom two in a numbered list:

Peek 2019-04-29 14-58

Similarly, if I scroll through https://www-huber.embl.de/msmb/Chap-Testing.html the footnotes in 6.3 seem to align with all the rest. Perhaps you can screen shot it too?

aridus commented 5 years ago

Screenshot from 2019-04-29 17-22-16

Many thanks for looking at this again. I have just installed 0.0.8 and recompiled my book (see attached screenshot). Footnotes 42 and 43, on the bulleted list are slightly to the left of footnote 44, which is on normal body text.

With thanks!