Diferencia entre revisiones de «Módulo:HtmlBuilder/doc»
De Familia Sanchez Arjona
m (7 revisiones importadas) |
(create rudimentary docs) |
||
| (No se muestran 33 ediciones intermedias de 15 usuarios) | |||
| Línea 1: | Línea 1: | ||
| − | + | This module creates html using a fluent Lua interface. | |
| − | === | + | == Usage == |
| − | |||
| − | + | to start with, you need to load the module: | |
| − | |||
| − | * <code>create()</code> - | + | <code>local HtmlBuilder = require('Module:HtmlBuilder')</code> |
| − | * <code>wikitext()</code> - | + | |
| − | * <code>allDone()</code> - | + | Then, you can create html using the following sub-functions: |
| − | * <code>tag()</code> - | + | |
| − | * <code>attr()</code> - | + | * <code>create()</code> - the basic function. All of the sub-functions are called from this. |
| − | * <code>css()</code> - | + | * <code>wikitext()</code> - normal wikitext text that occurs between html tags, or outside of html tags. |
| − | * <code>cssText()</code> - | + | * <code>allDone()</code> - this closes any open html tags. |
| − | * <code>addClass()</code> - | + | * <code>tag()</code> - this specifies which tag to use. It can be used to create unclosed tags using the <code>{unclosed = true}</code> parameter. |
| − | + | * <code>attr()</code> - specifies any attributes used in the html tag. | |
| − | [[ | + | * <code>css()</code> - specifies css styles used in a "style" attribute in the html tag. This sub-function accepts two parameters - the first one is the css property, and the second one is the value. E.g. <code>('background', 'red')</code>. |
| − | + | * <code>cssText()</code> - this sets css style as a text string containing both the css property and the value. E.g. <code>('background:red;')</code> | |
| + | * <code>addClass()</code> - this adds one more class value to the tag. | ||
| + | |||
| + | == Examples == | ||
| + | |||
| + | For examples, please see the [[Module:HtmlBuilder/testcases|test cases page]] and the [[Module talk:HtmlBuilder/testcases|test cases results]]. | ||
Revisión del 13:41 25 mar 2013
This module creates html using a fluent Lua interface.
Usage
to start with, you need to load the module:
local HtmlBuilder = require('Module:HtmlBuilder')
Then, you can create html using the following sub-functions:
-
create()- the basic function. All of the sub-functions are called from this. -
wikitext()- normal wikitext text that occurs between html tags, or outside of html tags. -
allDone()- this closes any open html tags. -
tag()- this specifies which tag to use. It can be used to create unclosed tags using the{unclosed = true}parameter. -
attr()- specifies any attributes used in the html tag. -
css()- specifies css styles used in a "style" attribute in the html tag. This sub-function accepts two parameters - the first one is the css property, and the second one is the value. E.g.('background', 'red'). -
cssText()- this sets css style as a text string containing both the css property and the value. E.g.('background:red;') -
addClass()- this adds one more class value to the tag.
Examples
For examples, please see the test cases page and the test cases results.
