Usage information

At this moment online tool of preliminary text formatting realize the following functionality: text cleaning and text preformatting with simple and clean syntax, which helps mark processed text with HTML tags.

Text requirements

Formatted or not formatter plain text, separated by lines from every text editor. The simplest example is copying text from Word editor and place it in formatting form on main page. Text will be formatted in blocks by lines.

Text cleaning

On firsts steps of text preformatting the service will clean duplicated white spaces characters and tabulation symbols. This option can be omitted. In that case text will keep it format after text processing. In addition all HTML tags will be removed, but in nearest future we will make possibility to keep they. After text cleaning service start process of parsing text and syntax. The syntax is case independent, what’s why you can use big or small letters, it doesn't matter.

Text and Syntax

Each line, processed with service will be wrapped in tag of paragraph <p> or tag of block <div>. It’s depends on the settings which you can choose on above the main form (by defaults this is a paragraph tag <p>). In addition to the formation of lines in service present a syntax, which allow you simply and quickly get HTML tags in your text. Right now there is two possibilities add tags:

Specifying a desired tag in the beginning of the line, allow you add oneline and multiline HTLM elements and wrapping current line with it. At this moment you can specify tags of Headlines <h1>-<h6>, tags <strong>, <b>, <sup>, <sub>, <small>, unordered <ul> and ordered <ol> list, and also paragraphs/blocks with built-in line wrapping with <br /> tag.

Specifying a desired tag in the line body, allow you add multi HTML tags in line by specially defined mask. Right now you can use <a>,<abbr>,<b>,<code>,<del>,<dfn>,<em>,<i>,<img>,<ins>,<small>,<span>,<strong>,<sub>,<sup> tags.

Each syntax construction, which starts with exclamation mark (!) will be ignored from processing. Notes what incorrectly used structures will be marked after text processing same way. If you will find syntax structure with exclamation mark in processed text, please check that the syntax was correct.

Quick reference

Oneline elements:
Wrapping line with headlinesh1 space in the beginning of the line before text (available values h1 to h6).
Wrapping line with strong tagstg or strong space in the beginning of the line before text
Wrapping line with b tagstb or b space in the beginning of the line before text
Wrapping line with sup tagsup space in the beginning of the line before text
Wrapping line with sub tagsub space in the beginning of the line before text
Wrapping line with small tagsml or small space in the beginning of the line before text
Multiline elements:
Wrapping lines with unordered listinsert uls before list and ule after list
Wrapping lines with ordered listinsert ols before list and ole after list
Wrapping lines with paragraph with
tag
insert pbs before paragraph and pbe after paragraph
Wrapping lines with block
tag
insert dbs before block and OLE after dbe after block
Inline elements:
Adding link tag aanywhere inside string a:url_address or a:attribute=data_without_spaces:attribute="data with spaces" (attributes href and text are mandatory)
Adding img taganywhere inside string img:path_to_file_without_spaces or img:attribute=data_without_spaces:attribute="data with spaces" (attribute src is mandatory)
Adding small taganywhere inside string small:data_without_spaces or small:attribute=data_without_spaces:attribute="data with spaces" (attribute text is mandatory)
Use same same technique for adding allowed tags <abbr>,<b>,<code>,<del>,<dfn>,<em>,<i>,<ins>,<span>,<strong>,<sub>,<sup>.

Full reference

For wrapping a line with headline use h1 with space in the beginning of the line before text. Usage:

For adding small text use same technique as with headlines. For wrapping a line with headline use sml or small with space in the beginning of the line before text. Usage:

For adding image with <img> tag you can use two syntax constructions: short and full. In short version you need edit manually the alt attribute of image tag. And in full version you can pass any attribute, including alt, in one construction (in full version attribute src is mandatory).

For adding link with <a> tag you can use two syntax constructions: short and full. In short version you need edit manually the internal text of link tag. And in full version you can pass any attribute, including href, in one construction (in full version attributes href and text are mandatory).

For adding other inline elements <abbr>,<b>,<code>,<del>,<dfn>,<em>,<i>,<ins>,<span>,<strong>,<sub>,<sup> you can use two syntax constructions: short and full (in full version text attribute is mandatory).

For adding lists in the text you need to outline a text block, which you wish wrap in list, and separate this part by adding new lines before and after text. After what you need to insert construction ULS or OLS at new line before text block and construction ULE or OLE at new line after block. Use ULS…ULE if you want make unordered lists and OLS…OLE for ordered lists. Usage:

In similar way, but little different syntax, you can wrap some part of text with paragraph or block tag with line wrapping inside. Line wrapping is realized through the usage of <br /> tag. In this case you need to outline a text block and add construction PBS or at new line before text block and construction PBE at new line after block. Use PBE…PBE if you want make paragraph with wrapped text or DBS…DBE for block with wrapped text. Usage:

At the moment this is a whole syntax and functionality, which is enough for me. However, if you have any comments or suggestions on expanding syntax or functionality of preformatting service feel free to write me, I will will update it with pleasure.

Usage

To make text preformatting the best is copying it from the source, for example text editor, by using Ctrl+C hotkeys and put the text in Text for processing field of service form, by using Ctrl+V hotkeys. Check the text for errors, it will go red (only if your browser get this functionality). After type syntax constructions in place you want to use they in text, including headlines, lists and others (see Quick reference). When text is marked and you are ready for getting preformatted text click Format button.

text preformatting
Text preformatting

In Text to copy field you will see preformatted text, which you can easily copy it. To do this, just make the field active, by clicking on it. When you are inside a field press hotkey Ctrl+A, which will select all text, and when press Ctrl+C. Pay attention for little text processing statistics above this field. In this field you can get information about the number of processed lines and number of characters, whit spaces and without. Sometimes this information if very useful :)

formatting results
Formatting results

Armed with this knowledge, you can already go to such a tiring and boring business, like text formatting for websites. And I hope that this service will be useful for you and become a permanent and helpful assistant!

With any comments or suggestions, feel free to write me.