Module:Wp/bcc/HtmlBuilder/doc

This is the documentation page for Module:Wp/bcc/HtmlBuilder

Template:Wp/bcc/tsh

The {{Deprecated template}} template notifies users that a given template has been replaced by a different one or ones, or simply deprecated (advised to no longer be used) without a replacement. This is useful when usage is different (so a redirect won't work) or you'd like to reduce the number of redirects (which makes bot parsing more difficult).

Whenever possible, it should replace the deprecated template's content entirely, so that someone using the template will see only the message.

UsageEdit

{{Deprecated template|old template name|new template name|dateTemplate:=سارتان/اکتوبر ۲۰۲۱}}


Usage without a second (replacement) template name simply produces:

Template loop detected: Template:Wp/bcc/Deprecated template

The template changes style depending on what kind of page it is shown on. Thus it adheres to the standardised looks for the different namespaces.

If a deprecated template is still in use on other pages, add Template:Tag tags around the

ERROR: This page is using an unprefixed version of template {{Tl}}

Use {{Wp/bcc/Tl}} instead and replace all occurences of {{Tl}} in Wp/bcc/ prefixed pages by that.Expression error: Unrecognized punctuation character "۱".

{{Deprecated template}} template. That way the template page will show the deprecation tag, but pages using it will not. If a template has been fully deprecated, meaning that it not in use on other pages, the noinclude tags may be removed. That way a deprecation tag will show on any page using the deprecated template. Afterwards consider nominating the template for deletion, or marking it with

ERROR: This page is using an unprefixed version of template {{Tl}}

Use {{Wp/bcc/Tl}} instead and replace all occurences of {{Tl}} in Wp/bcc/ prefixed pages by that.Expression error: Unrecognized punctuation character "۱".

{{Historical template}}.

ParametersEdit

Standard

{{Deprecated template|Old|New|dateTemplate:Wp/bcc/=Template:Wp/bcc/CURRENTMONTHNAME Template:Wp/bcc/CURRENTYEAR}} Template loop detected: Template:Wp/bcc/Deprecated template

Additional

The template can show parameters as follows:

{{Deprecated template|Old|New|parameter}}

{{Deprecated template|Old|New|<nowiki>parameterTemplate:Wp/bcc/=foo</nowiki>}} Template loop detected: Template:Wp/bcc/Deprecated template Template loop detected: Template:Wp/bcc/Deprecated template


The template can also show a note:

{{Deprecated template|Old|New|noteTemplate:=Further details can be inserted here}} Template loop detected: Template:Wp/bcc/Deprecated template

The

|note= parameter can also be given as

|reason= or

|result=.


Special parameters for templates outside template namespace.

|old= and |new= can be used with the full names including namespace.

{{Deprecated template|oldTemplate:=Template:Old|newTemplate:=Wikipedia:New}} Template loop detected: Template:Wp/bcc/Deprecated template

To link to a category full of templates, use :Category:Template:Var, with a leading colon.

The

|new= parameter cannot be used with the third unnamed parameter (the one illustrating a parameter of the third template). For example, this is not valid:
Template:Wp/bcc/in5Template:Wp/bcc/!mxt
Such a feature could be added, but it has never been needed yet.

Category suppression

The template can be prevented from categorizing by adding |nocat=true. This is only intended for examples, e.g. in the template's own documentation. In that case, not only the page itself will not be categorized, but transclusions of such pages will also be prevented from categorizing in Category:Pages using deprecated templates. Do not use this parameter to passive-aggressively contest a template's documentation. Take up the matter on the template's talk page or that of a relevant other venue, such as WP:Village pump (technical).

See alsoEdit

ERROR: This page is using an unprefixed version of template {{Tl}}

Use {{Wp/bcc/Tl}} instead and replace all occurences of {{Tl}} in Wp/bcc/ prefixed pages by that.Expression error: Unrecognized punctuation character "۱".

{{Dc2}} variant has Template:Dc2 (both explicitly use the Template:Tag element, and can be used in articles, e.g. about HTML or other specifications that may have deprecated features)

Template:Wp/bcc/sandbox other


Module:Wp/bcc/rating HtmlBuilder provides a way to construct complex HTML and CSS markup by creating a tree of nodes, similar to the Document Object Model. The result is a list of codes that are more comprehensible and maintainable than if you simply concatenated strings together. It offers a fluent interface that should look familiar to any user of jQuery.

Note: This module is deprecated in favour of mw.html.

UsageEdit

First, you need to load the module:

local HtmlBuilder = require('Module:HtmlBuilder')

Next, create the root HtmlBuilder instance:

local builder = HtmlBuilder.create()

Then, you can build HTML using the methods of the HtmlBuilder instance, listed below.

Finally, get the resulting HTML markup as a string:

local s = tostring(builder)

MethodsEdit

To allow chaining, all methods return a reference to the builder, unless otherwise stated.

tagEdit

local div = builder.tag('div') Appends a new child node to the builder, and returns an HtmlBuilder instance representing that new node.

doneEdit

builder = div.done() Returns the parent node under which the current node was created. Like jQuery.end, this is a convenience function to allow the construction of several child nodes to be chained together into a single statement.

allDoneEdit

builder = div.allDone() Like .done(), but traverses all the way to the root node of the tree and returns it.

wikitextEdit

div.wikitext('This is some [[Wp/bcc/HtmlBuilder/example|example]] text.') Appends some markup to the node. It may include plain text, wiki markup, and even HTML markup.

newlineEdit

div.newline() Appends a newline character to the node. Equivalent to .wikitext('\n').

attrEdit

div.attr('title', 'Attr value') Set an HTML attribute on the node.

cssEdit

div.css('color', '#f00') Set a CSS property to be added to the node's style attribute.

cssTextEdit

div.cssText('color:#f00; font-size:1.5em') Add some raw CSS to the node's style attribute. This is typically used when a template allows some CSS to be passed in as a parameter, such as the liststyle parameter of {{Navbox}}.

addClassEdit

div.addClass('even') Adds a class name to the node's class attribute. Spaces will be automatically added to delimit each added class name.

ExamplesEdit

local HtmlBuilder = require('Module:HtmlBuilder')

local root = HtmlBuilder.create()

root
    .wikitext('Lorem ')
    .tag('span')
        .css('color', 'red')
        .attr('title', 'ipsum dolor')
        .wikitext('sit amet')
        .done()
    .tag('div')
        .wikitext('consectetur adipisicing')

local s = tostring(root)
-- s = 'Lorem <span style="color:red;" title="ipsum dolor">sit amet</span><div>consectetur adipisicing</div>'


For more examples, please see the test cases page and the test cases results.