Editing conventions

Subjects[edit | edit source]

  • Briefly summarize the subject you want to write about. The Description Template is handy for this purpose
  • Lay out chapters inside of their corresponding sections, e.g. all the chapters about the subject "black body" must go under the Black Body section. To do so, use the Section Template
  • Chapters under the same section need to be inside a bullet list(*)
  • Every chapter can contain subchapters laid out in a sublist(**), but going beyond two levels is forbidden

Chapters[edit | edit source]

  • Chapters can be opened with a title-less paragraph and further paragraph subdivisions are not strictly required
  • Every title opening a paragraph must be written inside two double equal signs (==Title==)
  • Do not use bold or italic inside titles
  • Use a predefined formatting model when possible: look for a suitable one here: Template List
  • Chapters belonging to the same section can be referred to explicitly, e.g. "in the previous chapter we have seen...", while other chapters need to be referenced using links, e.g. "as already described in [[Chapter Name]], ..."
  • Avoid external references: if absolutely necessary, insert them as footnotes [1]

Text Formatting[edit | edit source]

  • To start a new paragraph you can use the html tag < br />, but entering two consecutive newlines is preferable
  • Use the <tt>...</tt> tag for inline code display, e.g.: "int sum(int a, int b); is a function declaration". To put more emphasis you can use <nowiki><code>...</code></nowiki> (a red box will surround the text)
  • Use the source tag for multiline code snippets, e.g.<source lang=python>...</source>. The lang parameter is necessary for correct syntax highlighting
  • Use the <math> tag for inline mathematical expression,even simple ones: <math>y=f(x)</math> is better than y = f(x). LaTeX is supported.

Images[edit | edit source]

  • Images must not be under copyright
  • Use images in vector graphics when possible (.svg format)

Tables[edit | edit source]

  • Avoid tables because they can't be exported to pdf at the moment.
  1. external link