docs/Title.md

   1 The MediaWiki software's "Title" class represents article titles, which are used
   2 for many purposes: as the human-readable text title of the article, in the URL
   3 used to access the article, the wikitext link to the article, the key into the
   4 article database, and so on. The class in instantiated from one of these forms
   5 and can be queried for the others, and for other attributes of the title. This
   6 is intended to be an immutable "value" class, so there are no mutator functions.
   7
   8 To get a new instance, call Title::newFromText(). Once instantiated, the
   9 non-static accessor methods can be used, such as getText(), getDBkey(),
  10 getNamespace(), etc. Note that Title::newFromText() may return false if the text
  11 is illegal according to the rules below.
  12
  13 The prefix rules: a title consists of an optional interwiki prefix (such as "m:"
  14 for meta or "de:" for German), followed by an optional namespace, followed by
  15 the remainder of the title. Both interwiki prefixes and namespace prefixes have
  16 the same rules: they contain only letters, digits, space, and underscore, must
  17 start with a letter, are case insensitive, and spaces and underscores are
  18 interchangeable. Prefixes end with a ":". A prefix is only recognized if it is
  19 one of those specifically allowed by the software. For example, "de:name" is a
  20 link to the article "name" in the German Wikipedia, because "de" is recognized
  21 as one of the allowable interwikis. The title "talk:name" is a link to the
  22 article "name" in the "talk" namespace of the current wiki, because "talk" is a
  23 recognized namespace. Both may be present, and if so, the interwiki must
  24 come first, for example, "m:talk:name". If a title begins with a colon as its
  25 first character, no prefixes are scanned for, and the colon is just removed.
  26 Note that because of these rules, it is possible to have articles with colons in
  27 their names. "E. Coli 0157:H7" is a valid title, as is "2001: A Space Odyssey",
  28 because "E. Coli 0157" and "2001" are not valid interwikis or namespaces.
  29
  30 It is not possible to have an article whose bare name includes a namespace or
  31 interwiki prefix.
  32
  33 An initial colon in a title listed in wiki text may however suppress special
  34 handling for interlanguage links, image links, and category links. It is also
  35 used to indicate the main namespace in template inclusions.
  36
  37 Once prefixes have been stripped, the rest of the title processed this way:
  38
  39 * Spaces and underscores are treated as equivalent and each  is converted to the
  40   other in the appropriate context (underscore in URL and database keys, spaces
  41   in plain text).
  42 * Multiple consecutive spaces are converted to a single space.
  43 * Leading or trailing space is removed.
  44 * If $wgCapitalLinks is enabled (the default), the first letter is  capitalised,
  45   using the capitalisation function of the content language object.
  46 * The unicode characters LRM (U+200E) and RLM (U+200F) are silently stripped.
  47 * Invalid UTF-8 sequences or instances of the replacement character (U+FFFD) are
  48   considered illegal.
  49 * A percent sign followed by two hexadecimal characters is illegal
  50 * Anything that looks like an XML/HTML character reference is illegal
  51 * Any character not matched by the $wgLegalTitleChars regex is illegal
  52 * Zero-length titles (after whitespace stripping) are illegal
  53
  54 All titles except special pages must be less than 255 bytes when encoded with
  55 UTF-8, because that is the size of the database field. Special page titles may
  56 be up to 512 bytes.
  57
  58 Note that Unicode Normal Form C (NFC) is enforced by MediaWiki's user interface
  59 input functions, and so titles will typically be in this form.
  60
  61 getArticleID() needs some explanation: for "internal" articles, it should return
  62 the "page_id" field if the article exists, else it returns 0. For all external
  63 articles it returns 0. All of the IDs for all instances of Title created during
  64 a request are cached, so they can be looked up quickly while rendering wiki text
  65 with lots of internal links. See LinkCache.md.