Future

From CODECS Dev

Future - development notes for now

[...]

Development

  • Using the testbench e.g. this manifest
  • Test that {{id}} is used as the 0.2 specs dictate.
  • In the interest of best practices, make sure all wg globals use the preferred method (incl. MainConfigNames), not the global keyword.

Matching scores

  • should also take into account alternative labels. Not just page label.

Temporary measures

  • Some temporary classes/files
  • Documentation contains a lot of development notes

On the to do list

  • Move TypeheadSearch parser function to this extension.
  • Code cleanup

Configuration settings:

  • wgReconUseDisplayTitle - whether searching by display title should be a default setting
  • ... - whether the use of a display title as label should be the default setting.
  • See for instance MWSuggestEntity, MWSuggestType

Specific to API output

  • Optimise for formatversion=2. Unlike version 1, it can output booleans.
  • Consistently apply the name 'meta' to metadata (per MW's other API modules) and mark section as meta. See ApiBase or ApiResult.
  • Consider whether 'meta' should be enabled for testing / debugging purposes only. Maybe offer a 'verbose'/'meta' setting (default: true).

Defaults

What should be the default settings?

  • displaytitle
  • what type to use
  • etc.

Bugs

Queries that can be useful for checking functionality

Beatha Aodha:

Dealing with redirects, identical titles and namespace prefixes

Redirect pages
  • Maybe better handling for redirects (MW) and see if we can treat them as alternative labels in post-processing queries. e.g. 'MainTitle [al. another title]'. The question remains though: are the page names of redirects to be understood as alternative labels? Sometimes a redirect is created because the original name was imperfect or erroneous and the redirect was created to allow for permanent access.


Disambiguators for identical names but in different namespaces?

Page Forms: "If there's more than one namespace, include the namespace prefix in the results".

Namespace prefixes
  • Should the namespace be shown or hidden? Only if display titles are not used?
  • Should this be a global setting?

Misc.

  • useDisplayTitle - in some cases, ambiguous. Does it refer to matching on display title, use of labels, or both? Often it's both.
  • APIReconQueryHandler - default source? Config? How change default without profile?
  • Should there be a default result limit?
  • Both StringModifier and ReconUtils contain a method that removes namespace prefixes. Consolidate.
  • Score: use this to re-sort results
  • Add section to documentation describing how to handle CORS. Part of settings documentation.
  • ReconAPIClassProp should provide for a default - null - if the admin wants to indicate it is not used on the wiki.
  • Check if an empty string is handled correctly. Should an empty string not yield any results at all?
  • Options to consider
    • Offer a way to preprocess user input, e.g. stripping away certain characters
    • Offer a setting that automatically removes html formatting