Difference between revisions of "WikiDB/Roadmap"

From TestWiki
Jump to: navigation, search
(Bugs)
(Planned features (in progress): + aliases)
 
(39 intermediate revisions by 3 users not shown)
Line 1: Line 1:
This is an (incomplete) list of features and bugs that need fixing for v1.
+
<div class="Information">
 +
; Do not add new feature requests to this page.
 +
: This page represents my own roadmap and should be maintained only by me.  Instead, use one of the following pages:
 +
:* Use '''[[WikiDB/Feature requests]]''' to request a new feature.
 +
:* Use '''[[WikiDB/Bugs]]''' to report a bug.
 +
</div>
  
== Bugs ==
+
This page contains the current roadmap for WikiDBThe list represents some of the things that I am currently exploring and my aspirations for future development, but it is unlikely to be a complete list and may not always be kept up-to-date as things evolve.
* <s>On [[table:Companies2|table display]], the definition is currently above the page title and sitenoticeThis only seemed to happen since I set 'MediaWiki:Sitenotice', so maybe has something to do with that - or maybe I just never noticed it for some reason? --[[User:HappyDog|HappyDog]] 00:00, 6 January 2007 (GMT)</s>
+
** It ''was'' to do with the site notice.  ParserBeforeStrip is being called once for each interface message that uses wiki text (I assume - it's being called for that one, anyway!).  I now use a flag so that the code in my hook only executes the first time it is called for a page.  This will only work if (a) the hook is called for every page view (i.e. it is not avoided by caching) and (b) it is always called first.  I don't know the answer to either of these, so if the bug resurfaces please let me know! --[[User:HappyDog|HappyDog]] 03:30, 23 January 2007 (GMT)
+
* <s>If a table doesn't have a definition, the 'data' tab is not displayed in 1.6.8 (it's ok in 1.5.6). --[[User:HappyDog|HappyDog]] 03:33, 23 January 2007 (GMT)</s>
+
** FIXED - In 1.5.6 the first tab is always 'nstab-main' - at some point this changed to include the namespace (e.g. nstab-table).  Now I just check the first 6 characters equal "nstab-".
+
* If I use a <nowiki><repeat></nowiki>-tag in a template and then use a template-parameter in the criteria-clause, then the parameter-value in the criteria-clause is not replaced by its value first. ([http://en.wikipedia.org/wiki/User:Stephanvaningen Stephanvaningen], 23 May 2007)
+
:* Like this: <nowiki><repeat table="handelaars" criteria="id={{{templateparametername}}}">{{{tablefield}}}</repeat></nowiki>
+
:* After that, I tried this:
+
:** <nowiki><repeat table="handelaars" criteria="id=50">{{template}}</repeat></nowiki>, with in the template then direct use of the field names from the table. This seems not to work
+
:** This I tried because I wanted to prevent writing *all* the table fields each time when calling the template: are there any possibilities there?
+
:***Hey, I actually got this to work.  I was able to use the <nowiki><repeat></nowiki> tag inside a Template using template parameters to feed the fields of the <nowiki><repeat></nowiki> tag using a MediaWiki Extension called [http://www.mediawiki.org/wiki/Extension:ExpandAfter ExpandAfter].  Follow the link to learn how to install it.  Once installed, use it like this in your template: '''<nowiki>{{#expandafter|repeat|table="handelaars" criteria="id={{{templateparametername}}}">{{{tablefield}}} }}</nowiki>''' What this extension does is parse out the template parameters BEFORE calling the WikiDB code for the <nowiki><repeat></nowiki> tag.  What's ''really cool'' about this ExpandAfter extension is that it works for ANY <nowiki><xxx></nowiki> tag in MediaWiki, not just the <nowiki><repeat></nowiki> or <nowiki><data></nowiki> tags for WikiDB, but for others too, such as any tags introduced by other extensions. -- [[User:Mdrayman|Mdrayman]] 04:35, 3 July 2007 (BST)
+
  
=== BUG: data tag still creates records inside of nowiki tags ===
+
<div class="Warning">
 +
'''Warning:''' This page does ''not'' guarantee that the suggested features will ever be implemented, nor does it indicate my development priorities - it simply represents my current thinking about the features I would like to add, in no particular order.
 +
</div>
  
If I put the following code in a wiki page, the table referenced in the <nowiki><data></nowiki> tag still makes a record show up in that tableIs there any way to illustrate to a user in a wiki page how to use the <nowiki><data></nowiki> tag without it adding records to the real table?
+
There are also good ideas from other people scattered around the wiki, particularly on the [[WikiDB/Feature requests|feature requests page]]Some of those suggestions get incorporated into this page, if there is a clear benefit and no obvious barriers to implementation.  Any ideas that have not been added to this page are still contenders for inclusion (particularly if demand is high); they are just not at the front of my mind.
<pre>
+
<nowiki><data table="ServiceCustomerJobs">
+
job_num=
+
account_num=
+
description=
+
date_called=
+
date_serviced=
+
completion_time=
+
job_page=
+
satisfaction=
+
complaint_page=
+
</data></nowiki>
+
</pre>
+
  
I bet that if you go look at the [[Special:Undefined Tables]] special page, there will be a new table called "ServiceCustomerJobs" because the <nowiki><nowiki></nowiki> tags didn't prevent WikiDB from using the <nowiki><data></nowiki> tag as a new record declaration.
+
== Planned features (in progress) ==
  
-- [[User:Mdrayman|Mdrayman]] 04:35, 3 July 2007 (BST)
+
=== Table definitions ===
  
== Administration ==
+
* Allow foreign keys to be defined.
 +
* Allow 'closed' tables (where all data is supplied on the schema page), as a method for implementing Enum fields.
  
* Update tables when page is moved.
+
=== Data types ===
* Update tables when page is deleted.
+
* Update tables when page is undeleted.
+
* (check that rollbacks work)
+
* 'What links here' should show templates that are included via data tags.
+
  
== Syntax ==
+
* Introduce new class-based method for defining data types (custom and internal) to improve code re-use and to make it easier to add new features.
 +
* Allow aliases to be specified (e.g. <code>int</code> and <code>integer</code>).  Currently you need to define the same type multiple times if you want this.
 +
* Add 'date' data-type.
  
* Better data syntax:  Need to allow multiple rows in a single definition.
+
=== Querying back-end ===
** Also, data definitions in a DB namespace shouldn't require the 'table' attribute (default to current).
+
* Repeat tag - some things to iron out (see below)
+
* Field names need to be limited to 255 chars (DB limit)
+
* Field names need to have leading underscores removed (Reserved for special uses)
+
  
== Repeat tag ==
+
* Allow JOINS in queries.
Still quite a way to go on this, but here's where I'm up to:
+
* Add support for boolean NOT operator (AND, OR and XOR are implemented, but NOT is unary and therefore trickier).
 +
* Add support for LIKE comparisons?
 +
* Add support for REGEX comparisons?
 +
* Add support for OFFSET/LIMIT.
 +
* Add support for field lists and DISTINCT clause.
 +
* Add support for calculated fields.
 +
* Add support for custom functions.
  
=== Done ===
+
=== Syntax ===
* Basic sort/filter is implemented.  Only limited filter options available, due to a parsing issue with MW/HTML.
+
* Contents of repeat tag are repeated for each row with variables expanded (see below for limitations).
+
  
=== To Do ===
+
* Formalise syntax for referring to identifiers and literals.
 +
* <code>&lt;repeat&gt;</code> tag:
 +
** Allow LIMIT argument (or maybe 'range'), possibly with pagination.
 +
** Add ability to specify field list and limit to DISTINCT rows.
 +
* <code>&lt;data&gt;</code> tag:
 +
** Provide a mechanism for 'pass-through' parameters (i.e. parameters that are supplied to the template, but which don't get added to the table).  Suggestion is to prefix the name with an exclamation mark.  Alternatively, an underscore could be used, as this is already reserved in table definitions, and therefore is not allowed in data tags (though this is not enforced) - may kill two birds with one stone...
 +
** Allow multi-line field data.
 +
 
 +
=== Interface ===
 +
 
 +
* Highlight 'bad' data on the table's data page.
 +
* Add special page to list all defined data types.
 +
* 'What links here' should show templates that are included via data tags.
  
* Tag Contents
+
=== Internals ===
** Aliases are currently expanding correctly, but not in a foolproof manner (e.g. aliases that point to aliases are not handled - this is a general issue, I think)
+
** Undefined fields - is their current handling OK?  Currently they will be expanded if defined for the row, and left as they are if not.  This might be the best behaviour, but perhaps not.
+
** Cannot currently supply default values for empty fields.  In any case (given the above point) default values for undefined fields must, by definition, be ignored (I think).
+
** Cannot handle nested vars.  Not a problem at the moment, but if default values are allowed, the default should be allowed to be an alternative variable (e.g. <code>{{{DisplayName|{{{ShortName}}}|No name defined}}}</code> should be valid syntax).
+
** Should strip blank lines at start and end.  Maybe restrict to stripping 1 line only (so &lt;repeat&gt; need not be on the same line as the start of it's content).  Should _not_ use trim(), as we need to allow for space at start of line (wiki &lt;pre&gt; syntax).
+
* Filtering
+
** Can't use &gt; in attribute values, e.g. criteria="Field>Value", as it cripples parser.  Need to decide how to specify criteria.
+
** In general - how detailed can we get?
+
* Other
+
** Ability to have header/footer? Ideally you put your header before the repeat tag, and the footer afterwards, but tables are screwed up by this (though I might be able to fix that somehow). There may also be other situations that cause problems.
+
  
== Code Tidying ==
+
* Code Tidying:
 +
** Add profiling statements.
 +
* Internationalisation:
 +
** Allow type names to be translated.
 +
** Allow type aliases to be translated.
 +
** Allow tag names to be translated?
 +
** Allow data to be translated?
  
* Ensure all user-visible text uses the message cache.
+
== Other possible features (speculative) ==
* Add profiling statements.
+
These are some thoughts on later developments, for further down the line.
* Move datatype handlers out of WikiDB class (into separate module).
+
  
== Misc ==
+
=== Interface ===
 +
* Form-based data entry.
  
* References to tables in table="..." attributes should follow redirects.  This allows tables to be moved without screwing everything up!
+
=== Data linking ===
* [[Special:UnusedTables]] to list tables that don't have any data (opposite of [[Special:UndefinedTables]]).
+
* Ability to specify joins between tables.
 +
* Able to specify relationships between data, e.g. 'is a type of'

Latest revision as of 17:35, 19 August 2021

Do not add new feature requests to this page.
This page represents my own roadmap and should be maintained only by me. Instead, use one of the following pages:

This page contains the current roadmap for WikiDB. The list represents some of the things that I am currently exploring and my aspirations for future development, but it is unlikely to be a complete list and may not always be kept up-to-date as things evolve.

Warning: This page does not guarantee that the suggested features will ever be implemented, nor does it indicate my development priorities - it simply represents my current thinking about the features I would like to add, in no particular order.

There are also good ideas from other people scattered around the wiki, particularly on the feature requests page. Some of those suggestions get incorporated into this page, if there is a clear benefit and no obvious barriers to implementation. Any ideas that have not been added to this page are still contenders for inclusion (particularly if demand is high); they are just not at the front of my mind.

Planned features (in progress)[edit]

Table definitions[edit]

  • Allow foreign keys to be defined.
  • Allow 'closed' tables (where all data is supplied on the schema page), as a method for implementing Enum fields.

Data types[edit]

  • Introduce new class-based method for defining data types (custom and internal) to improve code re-use and to make it easier to add new features.
  • Allow aliases to be specified (e.g. int and integer). Currently you need to define the same type multiple times if you want this.
  • Add 'date' data-type.

Querying back-end[edit]

  • Allow JOINS in queries.
  • Add support for boolean NOT operator (AND, OR and XOR are implemented, but NOT is unary and therefore trickier).
  • Add support for LIKE comparisons?
  • Add support for REGEX comparisons?
  • Add support for OFFSET/LIMIT.
  • Add support for field lists and DISTINCT clause.
  • Add support for calculated fields.
  • Add support for custom functions.

Syntax[edit]

  • Formalise syntax for referring to identifiers and literals.
  • <repeat> tag:
    • Allow LIMIT argument (or maybe 'range'), possibly with pagination.
    • Add ability to specify field list and limit to DISTINCT rows.
  • <data> tag:
    • Provide a mechanism for 'pass-through' parameters (i.e. parameters that are supplied to the template, but which don't get added to the table). Suggestion is to prefix the name with an exclamation mark. Alternatively, an underscore could be used, as this is already reserved in table definitions, and therefore is not allowed in data tags (though this is not enforced) - may kill two birds with one stone...
    • Allow multi-line field data.

Interface[edit]

  • Highlight 'bad' data on the table's data page.
  • Add special page to list all defined data types.
  • 'What links here' should show templates that are included via data tags.

Internals[edit]

  • Code Tidying:
    • Add profiling statements.
  • Internationalisation:
    • Allow type names to be translated.
    • Allow type aliases to be translated.
    • Allow tag names to be translated?
    • Allow data to be translated?

Other possible features (speculative)[edit]

These are some thoughts on later developments, for further down the line.

Interface[edit]

  • Form-based data entry.

Data linking[edit]

  • Ability to specify joins between tables.
  • Able to specify relationships between data, e.g. 'is a type of'