Skip to content

Suggestions #249

@nplatis

Description

@nplatis

In this issue I write down some suggestions on improving some lessons. They are ordered by lesson, not by importance or difficulty in implementing.

  • more-04: you write "but if you use babel shortcuts they won’t be active there.". This is too advanced, and babel has not yet been mentioned.

  • more-05: First mention of CTAN without having introduced it. Maybe explain in one sentence what it is.

  • lesson-07: When introduction floats, you should also probably mention \caption, as it is used in the example; also say that by using figure and caption, figures are numbered. As the text is now, there is a gap with the material of lesson-09.

  • more-07: graphicspath not clear (to me); you could mention that then you do not need the path in includegraphics

  • more-09: After the comment at the end, a short mention that hyperref has options to make all this much better looking could be added, otherwise the reader could be discouraged to use it!

  • lesson-10: The sentence "Note that all mathematics should be marked up as math, even if it is a single character use ... $2$ ... not ... 2 ... otherwise, for example, when you need a negative number and need math to get a minus sign the ... $-2$ ... may use math digits which may not be the same font as the text digits (depending on the document class)." could be rephrased. At least a ":" should be added after "character".

  • lesson-10: maybe also talk about \frac (it is used in more-15); also possibly about basic math functions such as \int, \sin, ...

  • lesson-11: "to prevent them from applying to the whole document" -> add "from that point on"

  • lesson-11: In the exercise, the sizing command \tiny is mentioned, maybe it should be added to the text.

  • lesson-12: "You might also notice that in the article title, some entries are in an extra set of braces" -> "some elements are in an extra set of braces"

  • more-12: The first section is almost repeating things already mentioned in lesson-12.

  • lesson-13: In the section on \include, maybe explain that each file produces its own .aux file. There has not been much explanation of .aux file, only in lesson 9 very briefly, and there it is mentioned as "auxiliary file", not ".aux file".

  • lesson-13: "The \appendix command changes the numbering " -> changes the chapter numbering

  • lesson-14: Font selection: maybe say that pdflatex fonts are not in ttf/otf

  • lesson-15: Maybe mention that all errors must be resolved; this is important for systems that continue processing without stopping at errors.

  • more-15: Maybe move section about spurious errors to the main lesson; it is a standard workflow and source of problems.

  • help: HTML output: the sentence "It may be specified at the same time as xelatex or lualatex as well as the default pdflatex processing." is not clear. What does "It" refer to? Also, is "at the same time" accurate? I understand it as though I could write % !TeX make4ht lualatex and get both outputs. Finally, " xelatex or lualatex as well as the default pdflatex " would probably be better as " xelatex or lualatex or the default pdflatex ".

  • settings: For the "return" and "engine" settings, a technical jargon is used which might be inappropriate for the audience of the site. Also, it is different than the terminology used in the "Help" page. A more user-oriented description could be better.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions