Универсальное форматирование текста

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

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

Универсальное форматирование состоит из двух вещей:

Первое. Это использование универсального редактора, который поддерживает заголовки и ссылки. При копировании текста из универсального редактора в редактор платформы, заголовки и ссылки будут сохранены.

Второе. Это работа с самим текстом: работа со структурой, выбор подходящих символов и прочее. Так например при создании списков не обязательно использовать форматирование, достаточно просто написать элементы с новой строки и добавить к ним маркер списка.

Примером универсального форматирования является данная публикация.

Основой структуры публикации являются заголовки, которые создают древовидную структуру:

Заголовок публикации (H1)

- Заголовок части (H2)

- - Заголовок раздела (H3)

- - - Заголовок подраздела (H4)

"Часть", "раздел", "глава" итд - все эти вещи можно называть как угодно. Суть в том, что заголовки это уровни, количество которых не ограничено. Обычно я использую три уровня (с учетом заголовка публикации). В больших публикациях, где есть разделение на части, я добавляю четвертый уровень. Больше чем четыре уровня я не использовал.

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

Можно сказать, что дочерние уровни являются списком элементов родительского уровня. К заголовкам дочерних уровней можно добавить символ длинное тире "—". Обычно я добавляют длинное тире к заголовкам самого нижнего уровня, к третьему либо четвертому.

Редакторы на платформах обычно ограничены тремя уровнями, чтобы добавить четвертый, нужно как-то выделить текст. Для этого как и в случае с дочерними уровнями, можно использовать длинное тире. В универсальном редакторе такой заголовок остается обычным текстом и не выделяется.

Некоторые части публикации можно сгруппировать друг с другом и отделить от других частей с помощью разделителя. В некоторых редакторах есть специальный элемент который так и называется "разделитель", он может представлять собой длинную черту либо выглядеть как-то иначе.

Чтобы создать собственный разделитель, можно добавить между уровнями несколько символов подчеркивания ( _____ ) и превратить в заголовок.

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

Длинное тире в заголовках выглядит не очень, если

• блок текста небольшой;

• в тексте есть список, элементы которого начинаются с обычного тире;

• в тексте много различных элементов, отличных от простого текста.

Длинное тире это просто один из элементов универсального текста, использовать данный символ необязательно.

Пояснение - это текст, который записывается в круглых либо квадратных скобках рядом с основным текстом. Цель пояснения сделать текст более понятным.

Круглые скобки используются внутри текста, чтобы пояснить слово либо предложение. Такие пояснения стоит размещать в конце предложения, а не в середине.

Квадратные скобки используются в отдельной строке, чтобы пояснить весь текст, который находится ниже.

Я бы не сказал, что пояснения делают текст лучше. Вместо пояснений лучше стараться писать обычный текст.

Если в текст добавляется пример, то он должен быть явно отделен от основного текста, чтобы пример и текст не сливались. Для этого с новой строки можно написать "Пример:", затем после двоеточия либо с новой строки сам пример.

При редактировании публикации в редакторе платформы может понадобится добавить ссылки, изображения и прочие элементы, которых нет в исходном тексте. В месте, где нужно добавить такой элемент, я добавляю заметку в круглых скобках. Например, заметка "(ссылка)" означает, что в текст нужно встроить ссылку.

Если автор пропустил заметку, то это заметит читатель и сообщит об ошибке автору. Такой подход позволяет эффективнее корректировать ошибки.

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

Пример был продемонстрирован в разделе "Структура публикации".

Плейсхолдер - это элемент текста, вместо которого может быть подставлен любой текст. Плейсхолдер обозначается фигурными скобками ( {} ). Если в публикации описывается программный код, то фигурные скобки будут конфликтовать с элементами кода, в таком случае я использую двойные кавычки-елочки ( «» ) .

пример:

Вот заголовок одной из моих публикаций: "Почему платформа {name} всегда будет токсичной". Вместо {name} можно подставить название любой платформы и это будет работать.

Однострочный список имеет формат "{текст} {элемент1}, {элемент2}", где после текста может идти символ двоеточия ( : ), где элементы перечисляются через запятую ( , ) либо через точку с запятой ( ; ).

Если элементы содержат обычную запятую, то для разделения элементов нужно использовать точку с запятой, чтобы было понятно в каком месте элементы отделяются друг от друга. В принципе можно всегда использовать точку с запятой и не парится насчет обычной запятой.

Многострочный список начинается со своего собственного заголовка. Под заголовком перечисляются элементы списка с добавлением символа буллит ( • ) либо символа тире ( - ) в начале строки. Если элементы небольшие и состоят из одного предложения, то точка в конце не ставится. Элемент может состоять из нескольких предложений, например, если нужно добавить описание элемента.

пример:

Список лягушек

• Красная лягушка

• Зеленая лягушка

• Синяя лягушка. Ква.

Любой однострочный список можно записать в виде многострочного, где вместо заголовка списка будет текст.

Пример был продемонстрирован в разделе "Длинное тире в заголовках - радость и боль", в подразделе "Минусы".

Некоторые слова в тексте могут представлять собой различные символы, наименования и прочее. То есть это текст, на который вы ссылаетесь. Такой текст записывается в исходном виде и оборачивается двойными кавычками ( " " ).

пример:

Как поделится картинкой в интернете: Нажать ПКМ на картинку => Нажать "Копировать" => Вставить в сообщение (CTRL + V) => Нажать "Отправить"

Многострочная инструкция представляет собой последовательность действий, нумерованный список, где в качестве маркеров списка используются числа.

пример:

Чтобы создать универсальный текст, нужно

1. Освоить принципы универсального форматирования

2. Написать текст в универсальном редакторе

3. Выбрать платформу по вашей тематике и опубликовать текст

Абзацы - это части текста, которые отделены друг от друга пустой строкой.

Скорее всего вы встречали большие абзацы, люди называют их "простыней текста".

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

Правило простое: Не делайте больших абзацев. Любой большой абзац можно разделить на несколько абзацев поменьше.

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

Следуя универсальному форматированию, ссылки нужно записывать в чистом виде и при желании форматировать в редакторе платформы.

Ссылка состоит из названия и самой ссылки. Можно написать название, двоеточие, затем ссылку. Либо можно написать название и в отдельной строке написать ссылку.

Далее текст ссылки нужно превратить в саму ссылку, на которую можно кликнуть. Для этого можно поставить курсор в конец ссылки и нажать клавишу ENTER. Либо можно выделить ссылку и нажать сочетание CTRL + K.

пример:

Самый популярный сайт в интернете: https://www.google.com

Код - это набор текста для файлов. Причем необязательно чтобы это был именно программный код.

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

пример:

_ _ _ .cmd _ _ _

echo Hello, world!

_ _ _ _ _ _ _ _ _ _

Вы можете копировать текст из универсального редактора в редактор платформы, текст сохранит заголовки и ссылки, будет иметь хорошую структуру.

При желании вы можете форматировать многострочные списки, чтобы они имели отступы, можете форматировать ссылки и блоки кода. Форматирование улучшит визуальную составляющую вашего текста и он будет популярнее.

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

Discord We Learn Internet - собираем полезную информацию.