User:Tangotango/Nubio/Editors' documentation

From Wikipedia, the free encyclopedia

Nubio is a pseudo-wiki, storing past revisions and supporting a subset of MediaWiki's wiki syntax. This page details the wiki syntax that Nubio supports and the inner-workings of its search engine.

Wiki syntax[edit]

Supported[edit]

The following features of MediaWiki wiki syntax are supported:

  • [[Wiki links]] and [[Wiki|Link]] (Internal links will act as if they were on the English Wikipedia. The usual inter-wiki prefixes are supported. Link expansion ([[Apple]]s) is not supported.)
  • [http://external.links] and [http://external.links External links]
  • The following tags: <tt><nowiki><code><b><i><s><span><pre>
  • {{tl|Templates}}
  • Double linefeeds (single linefeeds will be ignored, as does MediaWiki)

Removed[edit]

The following code syntaxes, if found, will be completely removed:

  • Tables
  • MediaWiki magic words
  • <ref> tags
  • HTML comments
  • All other HTML tags not mentioned

Converted to text[edit]

The following structures will be converted to text:

  • Wiki-style bold and italic apostrophes
  • The following templates: nihongo, coor*, nasdaq(2), lse, us patent, sehk(2), IPA, lang-fr, audio, zh-tspw, polytonic

Search function[edit]

Internal replacements[edit]

The MySQL fulltext search engine used does not support searching for words that are 3 characters or less. There are also a number of stopwords (documented at http://dev.mysql.com/doc/refman/5.1/en/fulltext-stopwords.html) that are completely ignored. For these reasons, Nubio internally replaces the following words with searchable equivalents when a user searches for them. Put the equivalent in your keywords list to make the unsearchable word searchable.

Example: If a user searches for "help with tables", they will (in the eyes of the MySQL engine) be searching for "assistance with tables".

  • help -> assistance
  • add -> addition
  • cd -> cdrom
  • dvd -> dvdrom

Helpful search[edit]

Nubio, by default, uses a small feature dubbed "helpful search" that, well, aims to be helpful to the searcher. Its main purpose is to ignore word forms for certain structures. The following rules are in place:

  • Any word ending with -ed gets the ending replaced with * (e.g., searching for "vandalized" actually looks for "vandaliz*"
  • Any word ending with -ing gets the ending replaced with * (e.g., searching for "searching" actually looks for "search*"
  • Any word ending with -s gets the ending replaced with * (e.g., searching for "wheels" actually looks for "wheel*"

This feature can be turned off if the user checks the relevant checkbox on search.php.