Indentation (typesetting)

From Wikipedia, the free encyclopedia
Jump to navigation Jump to search

Template:Short description Script error: No such module "redirect hatnote". Template:Use dmy dates Template:Sister project


In the written form of many languages, indentation describes empty space (white space) used before or around text to signify an important aspect of the text such as:

Many computer languages use block indentation to demarcate blocks of source code.

Indentation is essentially the same regardless of whether the writing system is left-to-right (e.g. Latin and Cyrillic) or right-to-left (e.g. Hebrew and Arabic) when considering line beginning and end. For example, indenting at the beginning of line means on the left for a left-to-right script and on the right for right-to-left script.

Indent is both a noun and a verb. The verb is the act of formatting text to be indented whereas the noun refers to the resulting empty space.

Types

There are three main types of indentation: first-line, hanging and block.

Each example below is in a box that represents the page boundary and uses the common typesetting lorem ipsum content. The width of indentation here is in units of em spaces.

Template:Glossary begin Template:Term Template:Defn Template:Term Template:Defn Template:Term Template:Defn Template:Defn Template:Defn Template:Glossary end

Indentation in programming

Script error: No such module "Labelled list hatnote".

In computer programming, indentation describes formatting source code with whitespace to the left of code text Template:Endash often to visually show that a sequence of code lines is syntactically a code block. Typically, the lines of a block are aligned with an amount of white space that indicates the block's depth in the hierarchical structure of the code. Each inner level of the hierarchy is indented by a multiple of this indentation width.

White space in code is typically stored as whitespace characters.

For a free-form language, indentation is exclusively for the programmer since a code processor (i.e. compiler, interpreter) ignores whitespace characters. Code can have inconsistent or even no indentation, but in general is formatted with somewhat consistent indentation.

Some languages rely on indentation to demarcate block structure, often via the off-side rule. Due to this syntax requirement, the code must have a level of consistency that is not required in free-form language code.

The neologisms outdent, unindent and dedent describe the opposite of indentation Template:Endash aligning code text of a line to the left of the previous line.

Variations

Common variations in the implementation of indentation include: how much to indent a block at each level of the code hierarchy, usually measured in spaces, and whether to store whitespace characters as space or tab characters. Although there are common practices, consensus is not universal. [1] These variations are driven by factors that may include but are not limited to: language syntax, organizational mandate and personal preference.

Common practices

The following table identifies notable practices with respect to code indentation.

Language Free-form? Note
Bash Yes Fritz Mehner's style guide suggests 2, 4, or 8 spaces and uses 2 in all examples[2]

Google uses 2 spaces [3]

C Yes The Linux kernel uses 1 tab[4][5]

NASA uses 4 spaces.[6]

Clinton Staley advocates 3 spaces[7]

C++ Yes WebKit recommends 4 spaces[8]

Google uses 2 spaces[9]

C# Yes Microsoft convention: 4 spaces[10]
CSS Yes Drupal, GitHub, and Google use 2 spaces[11][12][13][14]

WordPress uses tabs[15]

Dart Yes dart format uses 2 spaces
Delphi Yes Delphi style guide: 2 spaces [16]
F# Yes F# style guide: 4 spaces[17]
Go Yes Effective Go: 1 tab [18]
Haskell No Google uses 2 spaces[19]
HTML Yes Google uses 2 spaces[13]

HTML Tidy defaults to 2 spaces[20]

Java Yes Oracle uses 4 spaces[21]

Android uses 4 spaces[22]

Most Eclipse IDE components use tabs

JavaScript Yes Douglas Crockford advocates 4 spaces[23]

GitHub and Google use 2 spaces[24][25]

jQuery uses tabs[26]

Firefox's built-in jsbeautifier defaults to 2 spaces

prettyprinter in Google Chrome and Internet Explorer use 4 spaces

Julia Yes Julia style guide: 4 spaces[27]
Kotlin Yes Kotlin style guide: 4 spaces[28]
Lua Yes Lua style guide: 2 spaces[29]
Perl Yes Larry Wall prefers 4 spaces[30]
PHP Yes Drupal use 2 spaces[31]

PEAR and Zend use 4 spaces[32][33]

CodeIgniter and WordPress use tabs[34][35]

PSR-2 specifies 4 spaces[36]

PowerShell Yes Unofficial PowerShell Best Practices and Style Guide: 4 spaces[37]
Python No PEP 8: 4 spaces[38]
Ruby Yes Ruby style guide: 2 spaces [39]
Rust Yes Rust style guide: 4 spaces [40]
Scala Yes Scala style guide: 2 spaces [41]
Swift Yes Google uses 2 spaces[42]
Tcl Yes Tcl style guide: 4 spaces [43]
Visual Basic Yes Microsoft convention: 4 spaces [44]
XML Yes Google uses 2 spaces[45]

Elastic tabstops

In 2006, a new method of indentation was proposed, called elastic tabstops.Script error: No such module "Unsubst".

References

Template:Reflist

Template:Commons cat

  1. Script error: No such module "citation/CS1".
  2. Script error: No such module "citation/CS1".
  3. Script error: No such module "citation/CS1".
  4. Script error: No such module "citation/CS1".
  5. Script error: No such module "citation/CS1".
  6. Script error: No such module "citation/CS1".
  7. Script error: No such module "citation/CS1".
  8. Script error: No such module "citation/CS1".
  9. [1] Template:Webarchive
  10. Script error: No such module "citation/CS1".
  11. Script error: No such module "citation/CS1".
  12. Script error: No such module "citation/CS1".
  13. a b Script error: No such module "citation/CS1". This is an HTML-rendered copy of the official version, which is maintained in XML format
  14. Script error: No such module "citation/CS1".
  15. Script error: No such module "citation/CS1".
  16. Script error: No such module "citation/CS1".
  17. Script error: No such module "citation/CS1".
  18. Script error: No such module "citation/CS1".
  19. Script error: No such module "citation/CS1".
  20. Script error: No such module "citation/CS1".
  21. Script error: No such module "citation/CS1".
  22. Script error: No such module "citation/CS1".
  23. Script error: No such module "citation/CS1".
  24. Script error: No such module "citation/CS1".
  25. Script error: No such module "citation/CS1".
  26. Script error: No such module "citation/CS1".
  27. Script error: No such module "citation/CS1".
  28. Script error: No such module "citation/CS1".
  29. Script error: No such module "citation/CS1".
  30. Script error: No such module "citation/CS1".
  31. Script error: No such module "citation/CS1".
  32. Script error: No such module "citation/CS1".
  33. Script error: No such module "citation/CS1".
  34. Script error: No such module "citation/CS1".
  35. Script error: No such module "citation/CS1".
  36. Script error: No such module "citation/CS1".
  37. Script error: No such module "citation/CS1".
  38. Script error: No such module "citation/CS1".
  39. Script error: No such module "citation/CS1".
  40. Script error: No such module "citation/CS1".
  41. Script error: No such module "citation/CS1".
  42. Script error: No such module "citation/CS1".
  43. Script error: No such module "citation/CS1".
  44. Script error: No such module "citation/CS1".
  45. Script error: No such module "citation/CS1".