Помощь

На текущий момент сервис предварительного форматирования текста обладает следующим встроенным функционалом: очистка текста и преформатирование текста с использованием простого синтаксиса, позволяющим размечать обрабатываемый текст базовыми HTML тэгами.

Требования к тексту

Форматированный или неформатированный текст, разбитый на строки, из любого текстового редактора. Самым простым примером является простое копирование текста из редактора Word с последующим размещением в форму для форматирования на сайте. Текст будет разбит на абзацы построчно.

Очистка текста

На предварительном этапе обработки текста из него убираются все дублирующиеся пробельные символы и символы табуляции. Данную опцию можно отключить сохранив, первоначальное оформление текста. Помимо этого убираются все HTML тэги, возможно в дальнейших версиях будет возможно оставлять тэги. После очистки текста происходит разбор текста и синтаксиса. Синтаксис регистронезависимый, поэтому не будет разницы будете ли вы писать большими или малыми буквами.

Текст и синтаксис

Каждая строка текста, попадающая на обработку, заворачивается в тэг абзаца <p> или в тэг блока <div>, или вовсе не оборачивается, в зависимости от выбранных настроек (по умолчанию используется тэг абзаца <p>). Помимо формирование абзацев в сервисе добавлен синтаксис, позволяющий быстро и просто получать HTML тэги в получаемом тексте. На данный момент существует две возможности добавления тэгов:

Указание желаемого тэга в начале строки, позволяет добавлять в текст однострочные и многострочные HTML элементы, оборачивая текст в заданный тэг. На данный момент реализована возможно использование Заголовков <h1>-<h6>, тэгов <strong>, <b>, <sup>, <sub>, <small>, маркированных <ul> и нумерованных <ol> списков, а так же абзаца/блока со встроенным переносом строк через тэг <br />.

Указание желаемых тэгов в теле строки, позволяет добавлять множество HTML элементов по специально заданной маске в получаемые строки. На данный момент реализованы тэги: <a>,<abbr>,<b>,<code>,<del>,<dfn>,<em>,<i>,<img>,<ins>,<small>,<span>,<strong>,<sub>,<sup>.

Любая конструкция, начинающаяся с восклицательного знака (!), будет исключена из обработки. Обратите внимание, что неправильно сформированные конструкции после обработки так же помечаются данным способом. Если вы обнаружите выражение с восклицательным знаком в полученном тексте, проверьте правильность использования синтаксиса.

Краткая справка

Однострочные элементы:
Добавление заголовковh1 пробел в начале строки перед текстом (доступны значения от h1 до h6).
Добавление в строку тэга strongstg или strong пробел в начале строки перед текстом
Добавление в строку тэга bstb или b пробел в начале строки перед текстом
Добавление в строку тэга supsup пробел в начале строки перед текстом
Добавление в строку тэга subsub пробел в начале строки перед текстом
Добавление в строку тэга smallsml или small пробел в начале строки перед текстом
Многострочные элементы:
Добавление маркированных списковперед списком в новой строке uls, в окончании списка в новой строке ule
Добавление нумерованных списковперед списком в новой строке ols, в окончании списка в новой строке ole
Добавление абзаца с переносом строк внутри тэгом
перед текстом в новой строке pbs, в окончании текста в новой строке pbe
Добавление блока с переносом строк внутри тэгом
перед текстом в новой строке dbs, в окончании текста в новой строке dbe
Внутристрочные элементы:
Добавление в строку ссылок aв любом месте строки a:url_адрес_ссылки или a:атрибут=данные_без_пробелов:атрибут="данные с пробелами" (атрибуты href и text, добавляющий текст внутри ссылки, обязательны)
Добавление в строку картинок imgв любом месте строки img:путь_до_файла_без_пробелов или img:атрибут=данные_без_пробелов:атрибут="данные с пробелами" (атрибуты src обязателен)
Добавление в строку тэга smallв любом месте строки small:данные_без_пробелов или small:атрибут=данные_без_пробелов:атрибут="данные с пробелами" (атрибут text, добавляющий текст внутри тэга, обязателен)
Добавление остальных тэгов из разрешенного набора <abbr>,<b>,<code>,<del>,<dfn>,<em>,<i>,<ins>,<span>,<strong>,<sub>,<sup> происходит аналогичным образом.

Подробная справка

Для заворачивания строки в тэги Заголовков необходимо в начале строки указать код заголовка, например h1, и поставить пробел. Использование:

Добавление комментариев мелким шрифтом аналогично добавлению заголовков и распространяется на всю строку. Для обертывания строки в ее начале надо поставить конструкцию sml и поставить пробел.

Добавление изображений производится путем указания конструкции img:параметры в любом месте строки и в любых количествах. Если вы не желаете, чтобы данная конструкция обрабатывалась, достаточно добавить восклицательный знак (!) в начале конструкции (!img:default.jpg).

Синтаксическая конструкция добавления тэга картинки <img> реализована в двух вариантах, сокращенном (необходимо отредактировать атрибут alt по завершении форматирования) и в полном (любые атрибуты, включая alt, можно передать сразу, при этом атрибут src обязателен):

Синтаксическая конструкция добавления тэга ссылок <a> реализована в двух вариантах, сокращенном (необходимо отредактировать текст ссылки по завершении форматирования) и в полном (любые атрибуты, включая href, можно передать сразу, при этом атрибуты href и text обязательны):

Синтаксическая конструкция добавления остальных внутристрочных элементов <abbr>,<b>,<code>,<del>,<dfn>,<em>,<i>,<ins>,<span>,<strong>,<sub>,<sup> реализована в двух вариантах, сокращенном и в полном (атрибут text является обязательны):

Для получения списков необходимо выбрать нужный отрывок, после чего создать новую строку перед и после него. Для обозначения маркированного списка необходимо на новой строке перед текстом списка разместить конструкцию ULS или OLS, а на новой строке после списка разместить конструкцию ULE или OLE. Используйте вызовы ULS…ULE для обозначения нумерованных списков и вызовы OLS…OLE для нумерованных списков. Использование:

Аналогичным со списками способом, но другим синтаксисом, реализуется вставка абзаца/блока со встроенным переносом строк. Для обозначения переноса строки в данном случае используется тэг <br />. Структура для реализации данной возможности с использование абзацев PBS…PBE, а с использованием блоков DBS...DBE. Использование:

На данный момент это весь синтаксис и функционал, которого лично мне достаточно. Однако, если будут предложения по расширению функционала и по добавлению дополнительных тэгов, напишите мне, с удовольствием доработаю.

Использование

Чтобы преформатировать текст необходимо скопировать (Ctrl+C) текст из источника и разместить (Ctrl+V) его в поле Текст для обработки. После чего можно проверить синтаксические ошибки, которые браузер сам подчеркнет (если данная опция поддерживается браузером). После проверки орфографии можно дополнительно разметить текст заголовками и списками из раздела Текст и синтаксис. Когда текст промаркирован для обработки нажимаем на кнопку Форматировать.

предварительное форматирование
Предварительное форматирование

В поле Текст для копирования появится преформатированный текст, который можно легко скопировать. Для этого достаточно сделать поле активным, нажав на него. Выделить весь текст (Ctrl+A) и скопировать его (Ctrl+C). Обратите внимание, что над данным полем будет представлена краткая статистика по обработке текста. В ней можно узнать количество обработанных строк и количество символов, что бывает важно :)

результат форматирования
Результат форматирования

Вооружившись этими знаниями можно уже перейти к такому утомительному и скучному делу, как форматирование текста для сайтов. А я в свою очередь надеюсь, что данный сервис будет для вас полезен и станет постоянным и незаменимым помощником!

С любыми замечаниями и предложениями напишите мне.