Hello" output-html [ tag [p] tag [pre] tag [tt] tag [a] "Hello" end-tag end-tag end-tag end-tag ] == "
Hello" output-html [p [pre [tt [a Hello]]]] == "
Hello" The HTML dialect tracks which tags were inserted using the tag command, but not the === command or when using words directly. Whenever that happens, any tag that does not exist in the single-tags block inside the dialect context is tracked internally. Whenever you output an end-tag command, the last used tag is placed into the out-buffer. For the following examples, consider that >br<, >hr< and >img< are in the single-tags block: Examples: output-html [tag [p] tag [hr] end-tag] == "
my string
" ===Forms Creating forms with the HTML dialect is very straight forward: You add form elements and a submit button, and then when you submit the form, the server receives them via POST. The HTML dialect poses some intentional limitations on forms for simplifying the form system: * All HTML dialect forms send via the POST method. * There are no per-field settings yet, such as maximum field size. * There is no scheme yet for form validation, neither server- nor client-side. A form is created by stating the form action, name and possible default input values through an object. The form code is enveloped in a block. Each field element describes its associated name as a word! value. This method is fine, if you don't want default data to be put in the form or expect to revisit the form in a validation process, or if you are creating a form to be used on a completely static HTML page. Example: form submit.rsp [ div #label "Name" [field name] div #label "Address" [field address] div [submit "Submit Form"] ] Produces: The names used for each field in the form are the same as those used in the dialect. ---Using the Form Object If you use a get-word! in the form specifications, you will be able to attach an external object to the form. The object must already exist with the required content. This is a better method than the above one, if you desire to recreate the form with its existing data, or you wish default data to be put in the form. While the job of the HTML dialect finishes when rendering the HTML code, it means you can essentially tie form data to a fixed object that simply updates its values when you submit form data to the server, granted that you must write this part yourself. The ctx-html internal value is form-object, which is by default none. The added benefit is that the HTML dialect will let you auto-refill the form with the stored values in the object, when the page needs to be rendered again. The form object is stored internally in the ctx-html context as form-object. Example, showing a pre-existing form object, that has the same words as used in the form: form-data: make object! [ name: "Luke Lakeswimmer" address: "Tatooine Rebol Base" ] And in the form dialect code, we include form-data: form submit.rsp :form-data [ div #label "Name" [field name] div #label "Address" [field address] div [submit "Submit Form"] ] Produces: You can also create the form-data object inline in the dialect code or as a block of key/value pairs. ;===Highlighting ;It's possible to make automatic highlighting of words through a small sub dialect. This dialect will wrap specific words or sentences that are input in their entirety to html-gen. This is useful if you for example have developers' documentation (like this document) and want to highlight all commands in the text to make them stand out from the remaining text. The highlighting method involves enclosing the given text in a >span< tag that refers to a class called highlight. Example: ; output-html [highlight add "the" "The brown fox jumps over the dog."] ; == "The brown fox jumps over the dog." ;The highlighting will continue, even across multiple uses of html-gen or output-html until the highlighting setup list is changed or cleared. ;The default tag for this is the highlight class, but you can define your own: ; output-html [highlight add "the" using hl "The brown fox jumps over the dog."] ; == "The brown fox jumps over the dog." ;Remember, this is done in a single-pass operation, so if the words requested for highlight occur over several calls to html-gen, then the highlighting will not occur. Also when using multiple highlights inside eachother, only the outer highlight will be used. ;You can define multiple highlights by using the add subcommand, since all highlight setups are stored in a list. There is therefore also a remove and clear subcommand to, obviously, remove and clear the highlight list. ;Examples: ; highlight add "output-html" ; highlight add "html-gen" ; ... display text here ... ; highlight remove ; highlight add ; ... display text here ... ; highlight clear ; highlight add ===Dialect Rule Reference The following rule-sets describe how the dialect parser works. The entire parser is built from the rule blocks or sets below. Actions in the code (the parentheses), are left out for clarity. We start with the types and work our way from the low-level rules and up toward the main parser. ---block-types This describes all block types except for path! block-types: [block! | hash! | list!] ---value-types This rule defines the datatypes that describe values directly, such as numbers, strings and urls. Tags are purposely disallowed. value-types: [ money! | binary! | number! | date! | time! | tuple! | url! | email! | file! | any-string! | char! | pair! ] ---cell-types This rule defines the allowed datatypes for input parameters for most tags. It should be the same types as allowed in html-gen. cell-types: [ ['do block-types] | [ value-types | block-types | datatype! | word! | get-word! | lit-word! | path! | lit-path! | refinement! | logic! ] ] ---href-types These rules define URL inputs for use in page-rules. href-types: [['do block-types] | [word! | url! | string! | path! | refinement!]] ---doc-types This rule is used as a word-rule. doc-types: [ html-2.0-dtd | html-3.2-dtd | html-4.01-strict | html-4.01-transitional | html-4.01-frameset | xhtml-1.0-strict | xhtml-1.0-transitional | xhtml-1.0-frameset | xhtml-1.0-dtd | xhtml-basic-1.0-dtd | xhtml-basic-1.1-dtd | mathml-1.01-dtd | xhtml-mathml-svg-dtd | svg-1.0-dtd | svg-1.1-full-dtd | svg-1.1-basic-dtd | svg-1.1-tiny-dtd ] ---verbatim-rules These rules are output directly as they are input (verbatim). They are the first rules in the HTML dialect, as the input is not processed at all. verbatim-rules: [ value-types | tag! | lit-word! | path! | lit-path! | refinement! | datatype! | logic! ] ---eval-rules These rules are used for the TAG command. eval-rules: [any ['do block-types | any-type!]] ---base-rules These rules produce various types of common tags and links and are used as base for higher levels of rules. base-rules: [ '=== word! opt ['opts block-types] cell-types | 'tag into eval-rules | 'end-tag | 'do block-types | block-types ] ---link-rules These are the rules used with the at command to produce links using various input formats. link-rules: [ 'at [ 'page word! | 2 cell-types any [ 'vars [block! | object! | get-word!] | 'words block! ] ] ] ---image-rules These are the rules for producing image links. image-rules: [ image cell-types ] ---table-rules These are the main rules for building an HTML table. It uses several sub-rules which are described below. table-rules: [ 'table opt issue! any [ ['rows [get-word! | into table-row-rules | into table-block-rules]] | ['format block! 'rows [get-word! | into table-format-rules]] ] ] ---table-row-rules These rules define how a single row in a table can be shaped. table-row-rules: [ any [ 'row any [ ['cell | 'header] any [ 'colspan integer! | 'align word! | 'width integer! opt 'percent | 'class word! ] [none! | cell-types] ] ] ] ---table-cell-rule This table rule is used to generate a table cell, where there are multiple columns per row in the input data, or the input data consists of objects. table-cell-rule: cell-types ---table-row-rule This table rule is used to generate a table cell, where there is only one column per row in the input data and the input data does not consist of objects. table-row-rule: cell-types ---table-format-rules These rules are used after the format command and are identical in structure to table-block-rules, however when using blocks of blocks or plain blocks as input, the formatting is ignored. table-format-rules: [ any [object! | into [any table-cell-rule] | table-row-rule] ] ---table-block-rules These rules are used after the rows command without using format first. This means objects are just output cell by cell. The data row is parsed the same way as the formatting row. table-block-rules: [ any [object! | into [any table-cell-rule] | table-row-rule] ] ---tag-rule These rules are used in cases where a normal HTML tag is wanted. It can be used recursively. tag-rule: [ [ 'html | 'head | 'title | 'body | 'p | 'strong | 'em | 'b | 'i | 'u | 'tt | 'big | 'small | 'strike | 'del | 'pre | 'ul | 'il | 'li | 'sup | 'sub | 'samp | 'code | 'blockquote | 'q | 'kbd | 'var | 'cite | 'tr | 'th | 'td | 'table | 'a | 'div | 'span | 'dl | 'dt | 'dd | 'h1 | 'h2 | 'h3 | 'h4 | 'h5 | 'h6 ] opt issue! opt 'id word! [tag-rule | get-word! | cell-types | ()] ] ---tag-rules It looks redundant here, but in the source code, this rule collects all tags properly from recursive runs of tag-rule and generates the required HTML code. tag-rules: tag-rule ;---style-rules ; ;These rules manage style representations of larger blocks of code. ; ; style-rules: [ ; 'style word! block-types ; ] ---loop-rules These rules produce loops, and allow traversing data blocks either wholly or partially. loop-rules: [ 'loop integer! block-types opt ['alternate block-types] | 'traverse [block-types | get-word!] opt ['using [word! | 'lit-word | get-word! | block-types]] block-types opt ['alternate block-types] ] ---format-rules These rules allow special formatting parsers for text. The rules are meant to be extensible later, and are not really useful now. format-rules: ['format word! cell-types] ---form-rules These rules produce form tags and are considered a higher level of rules. They also manage the form content, either from words or a specific form object. form-rules: [ 'form cell-types opt [get-word! | ['vars | object!]] cell-types | 'textarea word! | ['field | 'button | 'hidden | 'password] word! | 'checkbox word! | 'radio word! | 'select word! opt ['values | 'key-values] cell-types | ['submit | 'reset] string! ] ---page-rules These rules produce the outer skeleton of the webpage by providing the HEAD and BODY section. page-rules: [ 'page cell-types any [ 'redirect href-types integer! | 'favicon href-types | 'charset [string! | word!] | 'css href-types | 'description string! | 'robots some [ 'noindex | 'index | 'nofollow | 'follow | 'noarchive | 'nosnippet | 'noodp | 'noydir ] | 'script href-types | 'meta ['name | 'http-equiv] 2 cell-types ] block-types ] ---error-rules These rules (actually only one rule for now) are used for handling and printing errors generated by the parser during HTML creation. They will be extended later to become more useful. error-rules: 'errors ---word-rules The word rules are used for lists of words that are either dynamic to the parser, i.e. lists of words that are built during parsing or are built into the HTML dialect, such as the word list for doc-types. word-rules: [doc-types | get-word! | word!] ---all-rules These rules are the collection of all the above mentioned rules. These rules are used directly by the parser, and you can see here in which order they are evaluated. all-rules: [ any [ verbatim-rules | base-rules | link-rules | image-rules | table-rules | tag-rules | loop-rules | format-rules | form-rules | page-rules | error-rules | word-rules ] ] ===Dialect Command Reference --- page Produces the outer skeleton for a webpage with correct HTML tags and DOCTYPE. Parsed as: 'page cell-types