730994 - migration: Convert and normalize template calls in documents

Status: RESOLVED FIXED

(developer.mozilla.org Graveyard :: Editing, defect)

Description

[Les Orchard [:lorchard]]

During the migration process, template calls in MindTouch documents need to be converted and normalized for kumascript.

For the conversion part, template calls currently exist in MindTouch documents in HTML constructs of the following general form:

    <span class="template">CSSXref('border')</span>

The new kumascript service expects syntax like the following:

    {{ CSSXref('border') }}

For the normalization part, MindTouch accepts a few different ways to call a template:

    MixedCaseName('parameter1', 'parameter2')
    bug(689641)
    template.lowercasename('border')
    wiki.template('英語版章題', [ "Reusing tabs" ])

We need to parse each of these template call forms and normalize to something like this for kumascript:

    {{ mixedcasename("parameter1", "parameter2") }}
    {{ bug("689641") }}
    {{ lowercasename("border") }}
    {{ 英語版章題("Reusing tabs") }}

In other words:

* Squash mixed case variants of template names to all lower case. Alternatively, ensure kumascript accepts all case variants.

* Call templates just by name in macros. Normalize all variants of template.{name} and wiki.template("{name}"...) down to the simple kumascript macro syntax

* Watch for direct calls to mindtouch API methods and replace them, or at least make note of them as templates that needs to be written

Comment 1

[Les Orchard [:lorchard]]

Here's a gzipped, tab-delimited list of page name and template call extracted from all MindTouch pages:

https://bugzilla.mozilla.org/attachment.cgi?id=591545

That's useful to get a look at what the universe of template calls look like.

Comment 2

[[github robot]]

Commit pushed to mdn at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/3f599fb445acacc93f1b24c3511f30563d67e36f
Merge pull request #142 from lmorchard/bug-730994-migrate-macros

Bug 730994 migrate macros