Хелп для нового редактора пользовательских блоков

[support]

В данный момент я плотно занимаюсь созданием хелпа для нового редактора пользовательских блоков. Для удобства работы я пользуюсь синхронизацией рабочих папок через Яндекс диск. То есть на Яндекс диске всегда самая свежая и актуальная версия разрабатываемого хелпа. Я хочу предложить Вам посмотреть уже написанный материал, ну и высказать своё мнение, может какие то ошибки, возможно некорректная или непонятная терминология, которую сейчас мне приходится придумывать.
В текущий момент работа ведётся в Word и для каждой странички будущего хелпа создается папочка, в которой находится директория с изображениями, и файлик «текст» в которой находится непосредственно текст страницы.
Пока всё это в таком виде – внести изменения, или исправления достаточно легко. После интеграции хелпа в программу, и на сайт, сделать это будет значительно сложнее.

В общем, я расшарил рабочую папку на чтение, и желающие могут помочь мне с созданием хелпа. Вот ссылка - https://yadi.sk/d/yiWkgcGdzhYLOQ.


UPD. Ну а если кто то, кто уже разобрался с редактором, напишет хотя бы одну страничку хелпа, и выложит её сюда, я буду безмерно счастлив. Мне меньше работы))).

UPD - 26-07-20
Закончил черновое написание хелпа для редактора. Предлагаю всем ещё раз ознакомится, и высказать своё мнение и свои пожелания если что то не понятно. В течении пары дней я буду устранять ошибки которые нашёл в программе, поле чего начну интегрировать хелп в программу и на сайт. После этого изменить что то в хелпе будет намного сложнее.

UPD - 01-08-20
Программа обновилась до номера 7-0-4. Закончен и интегрирован хелп. Подробнее здесь

[DrMario]

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

[support]

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

Это после хелпа. Хотя может кто и запишет из освоивших.

[rw6cm]

В данный момент я плотно занимаюсь созданием хелпа для нового редактора пользовательских блоков

Все хорошо! Спасибо!
На мой взгляд, для того чтобы начать, не хватает что то на подобие блок схемы, последовательность шагов при создании блока.
Желательно отобразить тот необходимый минимум, для создания простого моноблока, и мультиблока.
Можно сравнивать допустим как это делалось в старом блоке (на примере Вашего видео), и тот же пример в новом блоке.
Понял что в новом релизе не будет старого блока коде, следовательно придется пере собирать нужные блоки заново, и такой пример был бы к месту.
Новый блок в корне отличается от старого, и с ходу сориентироваться, даже для знающих не так просто )))

[Naladchik]

... непонятная терминология...

Мне кажется имеет смысл заменить слово "Инстанс" на "Экземпляр". Как-то более понятно звучит. Ну и слово "Скетч" пишется, все таки, без мягкого знака на конце.

[support]

Мне кажется имеет смысл заменить слово "Инстанс" на "Экземпляр"

Экземпляры то же есть. Инстансы - это блоки в пакете блоков, а экземпляры - это вытащенные на схему экземпляры инстансов. Веть один блок в пакете блоков можно вытащить на схему несколько раз. Как их называть? Я не придумал ничего лучше как экземпляры.

Ну и слово "Скетч" пишется, все таки, без мягкого знака на конце.

Исправлю. Хотя Word не ругался (проверяю его проверкой орфографии)

[aidar_i]

Хотя Word не ругался (проверяю его проверкой орфографии)

Support, как нибудь выделите время, пожалуйста, и на орфографию. Много ошибок и в старом и в новом блоках. В теме 7 версии даже выкладывали некоторые.
viewtopic.php?t=6451&start=80#p89861
Некомфортно, когда работаешь блоками от них, охота исправить , но нельзя:)

[Sancho]

Мне кажется имеет смысл заменить слово "Инстанс" на "Экземпляр"

Экземпляры то же есть. Инстансы - это блоки в пакете блоков, а экземпляры - это вытащенные на схему экземпляры инстансов. Веть один блок в пакете блоков можно вытащить на схему несколько раз. Как их называть? Я не придумал ничего лучше как экземпляры.

Думаю, что было-бы правильней или понятней слово инстанс заменить на модуль или ФБ(функциональный блок), да макрос наконец. Каждого из них может быть в проекте несколько экземпляров. ИМХО, инстанс и есть экземпляр.

[support]

ИМХО, инстанс и есть экземпляр.

Я знаю))))) (SmallTalk - это чистое ООП) Но фантазии не хватает. Буду думать.
Хотя если предложите стройную систему терминов, буду очень благодарен. И это надо делать сейчас, поскольку потом, когда хелп и редактор пойдёт в "народ", и термины приживутся, поменять их будет сложно.

Отправлено спустя 8 часов 55 минут 32 секунды:

ИМХО, инстанс и есть экземпляр.

Я знаю))))) (SmallTalk - это чистое ООП) Но фантазии не хватает. Буду думать.
Хотя если предложите стройную систему терминов, буду очень благодарен. И это надо делать сейчас, поскольку потом, когда хелп и редактор пойдёт в "народ", и термины приживутся, поменять их будет сложно.

Я вот тут думаю всё таки Вы правы, и я избавлюсь в принципе от термина "Инстанс". Непривычен он русскому уху))).
Наверное будет так
Сам блок в редакторе - "Мультиблок"
Блоки в пакете блоков - просто "Блок"
Вытащенные на схему блок - "Экземпляр блока".

Наверное так будет понятнее.
У Вас нет других предложений?

[rw6cm]

нет других предложений?

Можно где то использовать такие словосочетания, как:
"Часть блока, Фрагмент блока, Элемент блока, Составная часть блока,
Компонент блока, Звено блока, Секция блока, Составляющая блока, Отрывок блока,
Ингредиент блока, Сегмент блока, Эпизод блока, Деталь блока, Порция блока, Доля блока, "
Все эти словосочетания ассоциируются, как часть от целого.

[Naladchik]

Наверное так будет понятнее.

Наиболее логичная схема.

[Ardudue]

Сам блок в редакторе - "Мультиблок"

может просто назвать "Пакет блоков" или "Моноблок" тут сразу понятно что там есть еще блоки внутри.

[Rovki]

В Овен Лоджике это называется - макрос в макросе

[support]

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

[dekorator]

support, а на счет того чтоб добавить в переменные unsigned int и ввод в hex формате уже не судьба наверно? Писал я как то про это кажется 0.9 версии. Понимаю что не многим оно надо.

[ecoins]

support, а на счет того чтоб добавить в переменные unsigned int и ввод в hex формате уже не судьба наверно? Писал я как то про это кажется 0.9 версии. Понимаю что не многим оно надо.

и мне надо.

[rw6cm]

support,
Можно ли сделать описание ПБ, как в встроенных? Внешнее.
Чтобы вставлять фото, схемы, более подробное описание, и это не увеличивало объем самого блока.
Часто блоки делаются под периферию. Вид модулей, схемы подключения, под рукой было бы очень удобно.
И можно было дополнять/редактировать описание и встроенных блоков.
Или это очень сложно?

[Phazz]

Предлагаю как вариант сделать возможность вставки ссылок. Чтобы по ним можно было кликать. А справку на ПБ размещать форуме или сайте (там больше возможностей оформления).

[support]

Предлагаю как вариант сделать возможность вставки ссылок. Чтобы по ним можно было кликать. А справку на ПБ размещать форуме или сайте (там больше возможностей оформления).

Это черновой вариант. Он будет интегрирован в программу, и на сайт в основной хелп. И там будут перекрёстные ссылки между страницами естественно. Пока это просто текст. Мне ещё предстоит его перевести в вид HTML страниц

Отправлено спустя 14 минут 31 секунду:

Предлагаю как вариант сделать возможность вставки ссылок. Чтобы по ним можно было кликать. А справку на ПБ размещать форуме или сайте (там больше возможностей оформления).

Это черновой вариант. Он будет интегрирован в программу, и на сайт в основной хелп. И там будут перекрёстные ссылки между страницами естественно. Пока это просто текст. Мне ещё предстоит его перевести в вид HTML страниц

Упс, не сразу понял вопрос.
Ссылки в описание и сейчас можно вставлять как текст. Если кому надо будет - скопирует и вставит в браузер. Я конечно подумаю над возможностью прямого перехода из описаниы в браузер по ссылке, но это работа не двух минут, а думаю пары дней. Пока на это времени нет. Но идея в принципе хорошая, запишу в ToDo

[Naladchik]

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