Feature #1219

Статья-руководство для публикаций с использованием textile

Added by tin almost 2 years ago. Updated 4 months ago.

Status:In ProgressStart date:25/10/2015
Priority:NormalDue date:
Assignee:Izerg% Done:

10%

Category:ArticleEstimated time:5.00 h
Target version:-

Description

Подготовить статью-руководство описыващую методику написания публикаций и статей:

  • Стилистика статьи, шаблонные примеры
    • Работа с содержаниями
    • Оформление параграфов
    • Работа с ссылками и разделами статьи
  • Оформление и форматирование
    • Работа с изображениями
    • Работа со ссылками на внутренние источники и внешние источники
    • Работа с таблицами
    • Работа с выделением
    • Работа с фрагментами кода
    • Вставка спец-символов в статью, например ½
  • Работа с сокращениями и аббревиатурами
  • Сноски и подготовка изображений и публикации
    * Переводы и синхронизация мультиязычных статей
    * Дополнительные возможности движка xDevs.com в оформлении статей
    * Блок для вставки видеофрагментов с youtube
    * Блоки заметок, важных примечаний и предупреждений
    ** Ссылки на трекер redmine

Материалы для подготовки:

Textile redcloth help

Условия выполнения задачи

Resolved - Тикет считается закрытым по факту публикации гайда-шаблона по статьям xDevs.com
Failed - Гайд не готов по due date.
Suspended - Задача перенесена на более поздний срок либо заморожена по согласию сторон.

example_meow.tex - пример таблицы (4.14 KB) Izerg, 10/01/2017 11:00


Subtasks

Feature #1264: Style improvements for articlesNewtin

History

#1 Updated by tin over 1 year ago

  • Category changed from Documentation to Article
  • Subject changed from Article about using textile to Статья-руководство для публикаций с использованием textile
  • Description updated (diff)
  • Due date set to 20/11/2015
  • Priority changed from Low to Normal
  • Assignee changed from tin to Izerg

#2 Updated by tin over 1 year ago

Доп возможности:

Блок стиля предупреждения

p(#error_note). Текст

Блок стиля заметки

p(#side_note). Текст

Ссылка на документацию PDF

p(pdf_link). Текст

Требуется отступ (пустая строка) после параграфа для корректной работы блока.

#3 Updated by tin over 1 year ago

  • Description updated (diff)

#4 Updated by tin over 1 year ago

Форматирование оглавления:

Оглавление

* "Name_of_the_section":#link_to_section

...

Затем в тексте 

h2. %(#link_to_section)Name_of_the_section%

Таким образом при нажатии на ссылку в содержании окно браузера автоматически будет перенесено к фрагменту #link_to_section

#7 Updated by tin over 1 year ago

  • Делаем фтп-аккаунт для зерга

#8 Updated by Izerg over 1 year ago

http://wavedrom.com/
диаграма вместо рисунки.

#9 Updated by Izerg over 1 year ago

22 правила повествования от Pixar перевод
Работа с анимацией и 3D-графикой*

Эти правила впервые появились в твитах автора сценариев из Pixar, Эммы Коатс [Emma Coats]. Кстати, правило №9,– если вы застряли, сделайте список того, что не может произойти,- подойдёт для писателей, работающих в любых жанрах.

1. Восхищайтесь персонажем за его старания больше, чем за его успехи В теле статьи описывать конкретные действия , без выводов, все выводы - в конце статей. 
2. Отдавайте предпочтение тому, что интересно вам как зрителю, а не тому, что прикольно делать писателю. Эти два параметра могут сильно отличаться. Уровень читателя часто отличается от уровня специалиста в данной области, описание должно быть лаконичным, понятным, доступным, без академических вставок.
3. Стремиться к выражению лейтмотива – это замечательно, но пока вы не закончите историю, вы не сможете понять, о чём она на самом деле. А теперь перепишите её заново. текст статью подлежит многостадийной правке, от скелетного оформления до конечного результата, при этом в статье должна присутствовать одна центральная тема, о чем статья.
4. Жили-были… Каждый день они… А однажды… Из-за этого… Из-за того… Пока наконец не… В статье описываются ответы на вопросы: как, зачем, , когда, почему именно так, почему не по другому, другому, в чем необходимость именно этой статьи.
5. Упрощайте. Концентрируйтесь. Комбинируйте персонажей. Не отвлекайтесь на второстепенные сюжеты. Вы можете почувствовать, что упускаете нечто важное, но зато будете более свободным. П.п. 3 - в статье должна быть центральная тема, с небольшими отклонениями, для уточнения. все отклонения выполняются в виде ссылок на внешние ресурсы, статьи.
6. В чём ваш персонаж преуспевает, что ему нравится? Дайте ему прямую противоположность. Бросьте вызов. И как он будет справляться с этим? Обоснование предложенного в статье решениея, метода, подхода, описание превосходства над аналогичными методами, решениями, подходами.
7. Придумайте конец раньше середины. Реально, окончания придумывать труднее, поэтому озаботьтесь о том, чтобы ваше сработало, заранее. Эксперимент ставится с целью подтвердить и ли опровергнуть результаты гипотезы, аналдолгично статья - подтверждение или опровержение предложенного решения.
8. Закончив историю, отложите её, даже если она несовершенна. В идеальном мире всё было бы по-другому. В следующий раз сделаете лучше. Завершенная статья подвергается рецензированию. Результаты рецензирования - пункты правки, шаблоны для последующих статей.
9. Если вы застряли, сделайте список того, что НЕ может произойти. Часто после этого вы находите подходящий материал.
10. Разберите истории, которые вам нравятся. То, что вам в них нравится, является частью вас – вам нужно распознать это перед тем, как вы сможете это использовать. Перед написанием статьи - необходимо рассмотреть существующие медоды, их преимущества и недостатки. на основаниии этого делается вывод о необходимости написании новой статьи.
11. Вы сможете исправить идею только после того, как оформите её на бумаге. Если она останется у вас в голове, вы не сможете ею поделиться. Материал статьи должен быть изложен в печатном виде.
12. Отбросьте первое, что приходит в голову. А затем второе, третье, четвёртое и пятое. Все очевидные вещи. Удивите себя. Перед составлением материалам статьи - неодбходим плат работ по материалам и по сопутствующим инструментам.
13. Снабдите персонажа мнением. Пассивные и покладистые персонажи могут нравиться вам, но не вашей аудитории. хороший, теплый ламповый коментарий (С)
14. Почему вам необходимо рассказать именно эту историю? Какое из ваших убеждений её подпитывает? Является её сердцем? (no comment)
15. Как бы вы чувствовали себя, находись вы на месте вашего персонажа? Честность добавляет правдоподобия в невероятные ситуации.+(no comment)+
16. Что на кону? Почему мы должны переживать за персонажа? Что случится, если они не добьются успеха?
17. Работа зря не пропадает. Если это не работает сейчас, отложите идею – она обязательно пригодится в другом месте. Описательная часть выводов.
18. Познайте себя и почувствуйте разницу между достижением наилучшего результата и беспокойством из-за пустяков.
19. Случайности, втягивающие персонажей в неприятности, отлично играют. Случайности, выручающие их оттуда, выглядят, как обман. Работа по плану и содержанию, без отклонений от центральной темы статьи.
20. Упражнение: возьмите составные части кинофильма, который вам не понравился. Как бы вы перераспределили их так, чтобы он стал вам нравиться?
21. Необходимо идентифицировать себя с ситуацией и персонажем. Что заставило бы вас лично действовать подобным образом? Описание от первого, третьего лица.
22. В сём суть вашей истории? Как максимально эффективно рассказать её? Определитесь, и отталкивайтесь от этого. Краткость и точность выводов, возможность использования выводов качестве

#10 Updated by tin over 1 year ago

Выпилить кнопки в редмайне.

#11 Updated by tin over 1 year ago

Youtube:

<div class="video_frameWrap"><iframe class="video_frame" width="960" height="540" src="https://www.youtube.com/embed/IEzH6rZCFjQ"></iframe></div>

#12 Updated by Izerg over 1 year ago

  • Status changed from New to Suspended

#13 Updated by tin over 1 year ago

Добавлен новый стиль для табличных и фото сносок:

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

p=. !http://xdevs.com/doc/xDevs.com/Neutron/sch/sch_fdrv.png!
%(imgref)Image 1: MOSFET driver schematics, single-channel%

#14 Updated by tin over 1 year ago

По мотивам Common Textile Problems and Questions

[_image[*_1*].jpg_]

Тестирование для textile:

http://txstyle.org/

#15 Updated by Izerg over 1 year ago

  • Status changed from Suspended to In Progress

#16 Updated by tin over 1 year ago

Как там наш текстильчик поживает?

Список тегов, на всякий пожарный:

MODIFIERS = {
"*" => 'strong', # bold
"_" => 'em', # italic
"+" => 'ins', # underline
"-" => 'del', # deleted
"^" => 'sup', # superscript
"~" => 'sub' # subscript
}

Например super sub

#17 Updated by tin over 1 year ago

Тестовый сайт реализован в #1297

#18 Updated by Izerg over 1 year ago

  • % Done changed from 0 to 10
  • Estimated time set to 5.00

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

Стилистика статьи, шаблонные примеры
- Работа с содержаниями-
Оформление параграфов
Работа с ссылками и разделами статьи
Оформление и форматирование
Работа с изображениями
Работа со ссылками на внутренние источники и внешние источники
Работа с таблицами
Работа с выделением
Работа с фрагментами кода
Работа с сокращениями и аббревиатурами
Сноски и подготовка изображений и публикации
Переводы и синхронизация мультиязычных статей
Дополнительные возможности движка xDevs.com в оформлении статей
Блок для вставки видеофрагментов с youtube
- Блоки заметок, важных примечаний и предупреждений-
Ссылки на трекер redmine

#19 Updated by tin over 1 year ago

Izerg wrote:

- вложенное форматирование не работает

Например? Ссылку с нерабочим примером на сайте было бы здорово посмотреть.

- методику отображения картинок нужно поэтапно описывать

Верно. Кусок можешь позаимствовать отсюда

- эпизодическое выпадание сайта в осадок при некорректных действиях

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

- разбить статью на 2 части - собственно textile и собственно "литературная стилистика", перваяя часть - чисто техническая с примерами, вторая - методы и стили подачи информации ( описания, обращения, пояснения, дополнения, исправления)

Я против :). Давай сперва осилим единую одну статью, а там будет видно разбивать или нет.

- заключительная часть - выводы.

Стилистика статьи, шаблонные примеры
- Работа с содержаниями-
Оформление параграфов
Работа с ссылками и разделами статьи
Оформление и форматирование
Работа с изображениями
Работа со ссылками на внутренние источники и внешние источники
Работа с таблицами
Работа с выделением
Работа с фрагментами кода
Работа с сокращениями и аббревиатурами
Сноски и подготовка изображений и публикации
Переводы и синхронизация мультиязычных статей
Дополнительные возможности движка xDevs.com в оформлении статей
Блок для вставки видеофрагментов с youtube
- Блоки заметок, важных примечаний и предупреждений-
Ссылки на трекер redmine

#20 Updated by Izerg over 1 year ago

tin wrote:

Izerg wrote:

- вложенное форматирование не работает

Например? Ссылку с нерабочим примером на сайте было бы здорово посмотреть.

Да-да ... вот как допишу - там будет красная нотатка "так делать не надо, не работает" :)

- эпизодическое выпадание сайта в осадок при некорректных действиях

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

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

- разбить статью на 2 части - собственно textile и собственно "литературная стилистика", перваяя часть - чисто техническая с примерами, вторая - методы и стили подачи информации ( описания, обращения, пояснения, дополнения, исправления)

Я против :). Давай сперва осилим единую одну статью, а там будет видно разбивать или нет.

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

- заключительная часть - выводы.

вон пример, когда редмайн даже собственное формотирование прожевал и проглотил :)

#21 Updated by Izerg over 1 year ago

Хз, у меня ОК, если ты про https://izerg.xdevs.com/article/Textile/
З.ы. урлы именуем маленькими буковками (они же Case-sensetive). Можешь добавить в гайд.

хорошо, добавлю.

Оглавление неправильно сделано :)

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

#22 Updated by tin over 1 year ago

- заключительная часть - выводы.

вон пример, когда редмайн даже собственное формотирование прожевал и проглотил :)

Посмотрел исходный текст - не видно форматирования дополнительного, так что я ж не знаю как должно быть и что ты писал :)

Оглавление неправильно сделано

Там совсем не работало "от рождения" , суть не в блекджеке :-)

#25 Updated by tin over 1 year ago

Cтатья уже нужна, два автора ждутъ руководств :(

#26 Updated by Izerg over 1 year ago

так: текущий вопрос:
работа с содержанием и линками вообще:
открываем статью https://izerg.xdevs.com/article/rpi_spi/
оглавление работает только, если линки открывать в новой вкладке броузера, на локальной странице навигация по оглавлению не работает.
открываем в соседней вкладке туже статью но https://xdevs.com/article/rpi_spi/
и о чудо - навигация работает локально на странице - никакие новые вкладки не нужны ...
броузер фирефокс, 43.0.1.
Обновил фирефокс до 44.0 - страницы заработали одинаково. Навигация по содержанию работает.
какого рожна ему надо?

#27 Updated by Izerg over 1 year ago

а шо в админке в редакторе статей кнопка "линк" так странно работает:
запрашивает название - ввожу "Введение"
запрашивает сам линк - ввожу "#vvedenie"
в итоге получаю строчку " "Your text to link here...(Введение)":#vvedenie "
это зачем оно так ?

#28 Updated by Izerg over 1 year ago

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

#29 Updated by tin over 1 year ago

Жму ссылку, все работает как положено, в том же окне.

Opera 34.0.2036.50
Firefox 43.0.4
Chrome Version 48.0.2564.97 m

Кнопки забиты гвоздями.

#30 Updated by Izerg over 1 year ago

я экспериментально выяснил, что перестает работать - если зашел с админскими правами править статью и паралельно ее смотреть.

#31 Updated by tin over 1 year ago

Все должно уже работать без ограничений.

#32 Updated by Izerg about 1 year ago

Работа со ссылками на внутренние источники и внешние источники

#33 Updated by tin about 1 year ago

Эмм? Кто здесь..

#34 Updated by Izerg about 1 year ago

tin wrote:

Эмм? Кто здесь..

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

#35 Updated by tin about 1 year ago

Ехал на велике сегодня и пришла мысля что надо бы во введение написать зачем вообще статьи писать.

  • Для документирования проекта
  • "напоминалка" самому себе на будущее, когда надо будет вернуться к проекту
  • Руководство последователям
  • Как элемент резюме у автора.

#36 Updated by tin about 1 year ago

  • Description updated (diff)

#37 Updated by tin about 1 year ago

Добавлен пункт: Вставка спец-символов в статью, например ½

На данный момент я широко использую следующие:

Код в исходнике Результат
&Omega; Ω
&frac12; ½
&plusmn; ±
&deg; °
&times; ×
&micro; µ
&Sigma; Σ
&Delta; Δ

Пример использования:

Резистор 1000 &Omega; был измерен с точностью &plusmn;0.10% + поправка 560&micro;&Omega;. Температура среды равна +23.6&deg;C. Измерение проведено с помощью &Delta;-&Sigma; ADC.

Выходная строка:

Резистор 1000 Ω был измерен с точностью ±0.10% + поправка 560µΩ. Температура среды равна +23.6°C. Измерение проведено с помощью Δ-Σ ADC.

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

#38 Updated by Izerg about 1 year ago

tin wrote:

  • Для документирования проекта
  • "напоминалка" самому себе на будущее, когда надо будет вернуться к проекту
  • Руководство последователям
  • Как элемент резюме у автора.

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

#39 Updated by Izerg about 1 year ago

tin wrote:

Добавлен пункт: Вставка спец-символов в статью, например ½

Ок, дойду - разберусь - сделаю.

#40 Updated by tin 6 months ago

Все хорошо!

#41 Updated by tin 6 months ago

  • Description updated (diff)

#42 Updated by tin 6 months ago

  • Description updated (diff)

#43 Updated by tin 6 months ago

  • Description updated (diff)

#44 Updated by Izerg 4 months ago

#45 Updated by Izerg 4 months ago

рабочий пример должен выглядеть так:
https://xdevs.com/article/hp3458b/

#46 Updated by Izerg 4 months ago

  • Assignee changed from Izerg to tin

**Работа со ссылками на внутренние источники и внешние источники
что такое внутренние источники?

*Сноски и подготовка изображений и публикации
если есть "https://xdevs.com/guide/hwphoto/", то изображения мы пишем или нет?
или кратко "900 пикселей /450 пикселей jpeg/png" достаточно?
питоновый скрипт, в плане текстиля нужен или не нужен ?

#47 Updated by tin 4 months ago

внутренние - тот же домен

просто вместо ссылки на https://xdevs.com/doc/testfolder/document.pdf просто пишем ссылку на /doc/testfolder/document.pdf

питон пишем. Кратко картинки правила пишем, для примера.

#48 Updated by Izerg 4 months ago

  • Assignee changed from tin to Izerg

Also available in: Atom PDF