Russian Qt Forum

Всем привет.

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

А мне было бы интересно ваше мнение - как код? Не претендую на полномасштабный ревью, но может всё-таки взглянете хотя бы на способ взаимодействия слоя бизнес логики со слоем хранения данных? или может быть вас заинтересует постраничный редактор а-ля ворд на основе QTextEdit'а?;)

Вобщем, кому не лень, или наоборот нечего делать - милости просим! Вот ссылка на гитхаб - https://github.com/dimkanovikov/Scenarist, там в ридми есть ссылка на сайт самого проекта, если вдруг понадобится более подробная информация о нём. Или пишите прямо сюда, я с удовольствием готов обсудить любые вопросы!

Как бы тему-то развеселить? Может быть вам было бы интересно узнать какие-то технические моменты?

Расскажите что вас сподвигло на ее создание :) да и про предметную область интересно узнать :)

gil9red, спасибо за вопросы :)

Идея создать программу для сценаристов возникла довольно спонтанно. Хоть я немного и связан с кинематографом (моя жена актриса), но задуматься о создании программы меня подтолкнула одна деловая встреча с режиссером в Москве. От него я вкратце узнал об индустрии, о существовании некоего формата сценария и о программе под названием Final Draft. Тема меня заинтересовала, а небольшое знакомство с ней показало, как программы, призванные упростить процесс создания сценария, усложняют жизнь сценаристов пишущих на русском (да и любом другом, отличном от латиницы) языке (используются шрифты не поддерживающие кириллицу, некоторые просто не работают с utf-8, в третьих через раз работает сохранение документов в пдф и т.п.). А мне давно уже хотелось поучаствовать или запустить свой опен сорс проект, вот я и решил, что пришло время его запустить. :)

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

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

Добавь, чтобы программа сама вычисляла ляпы и плагиат. ;)

Dimka Novikov, спасибо, интересная тема :)

Пантер, :)

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

и тем не менее ляпы везде сплошь и рядом )

Всем привет.

Сегодня хочу рассказать об архитектуре проекта в общих чертах.

Итак, вся система разбита на шесть слоёв:
(http://kitscenarist.ru/assets/images/dev/01_common_arch.png)

Вверху на картинке показаны два общедоступных слоя (т.е. знать о них разрешено любой функции/классу из любого другого слоя):
1. Модель предметной области
Фактически представляет собой отображение схемы базы данных в объекты.
2. Вспомогательные элементы
Здесь находятся все универсальные решения, а так же все сторонние решения, обнаруженные в интернете. В основном это виджеты и делегаты, но так же есть несколько вспомогательных классов, которые используются повсеместно в проекте.

Далее идут слои, являющиеся пожалуй, основными составляющими программы. Слева идут три слоя, которые замыкаются на себе, т.е. им разрешено знать о сущностях находящихся в собственном слое, а так же о сущностях общедоступных слоёв. Управленческий же слой берёт на себя обязанность по координации взаимодействия между всеми слоями приложения. Это моя своеобразная интерпретация паттерна модель-представление-контроллер. Т.к. слои независимы, они легко разносятся, что облегчает создание новых систем на основе имеющейся.

Дальше чуть более подробно о каждом из них:
3. Слой хранения и обработки данных
Скрывает в себе три подслоя, которые в свою очередь предоставляют: а) интерфейс доступа к базе данных; б) загрузку данных из базы и преобразование их в модель предметной области; в) собственно доступ к загруженным объектам.
4. Слой бизнес логики
Сосредотачивает в себе все тонкости работы с киносценарием: подсчёт хронометража, построение структуры сценария, импорт/экспорт сценария из/в документы различных форматов и т.д.
5. Слой пользовательского интерфейса
Мне нравится, когда интерфейс тупой, просто отправляет сигналы в нужный момент и загружает предоставляемые ему данные в заданные поля. Но в данном проекте есть одно большое исключение - это собственно сам редактор сценария (ScenarioTextEdit). Он вместе с группой зависимых классов является, как представителем слоя пользовательского интерфейса, так и входит в управленческий слой. Сделано это потому, что сам редактор довольно специфичный и разделение его на два независимых класса принесло бы больше проблем/сложностей/трудозатрат, чем их объединение.
6. Управленческий слой
Как и говорилось раньше, этот слой берёт на себя ответственность за координацию взаимодействия между всеми слоями приложения, от первого пункта меню, до вопроса о сохранении редактируемого проекта при закрытии программы.

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

Постепенно я буду выкладывать всё более детальные подробности, если вас что-то заинтересовало, вы хотите что-нибудь покритиковать, или уточнить - УРА! :) Пишите, мне очень интересно ваше мнение.

Есть ли какие-то возможности вносить вклад в ваш проект? )
Ну например, исправление багов, добавление нового функционала, улучшение текущего )

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

Если у вас есть список проблем или todo было бы круто: когда накатит по программировать, можно было сделать форк проекта, исправить в нем баг или доработать, и после коммита сделать pull request ^^
На постоянной основе я бы не стал заниматься -- и так на работе с утра до вечера программирую, и придя затемно домой хочется заняться чем-нибудь другим ))
Поэтому, на меня накатывает желание по программировать свое в праздники или в выходные (и то редко) :)

// После учебы начинаешь понимать как много было свободного времени, которое можно было потратить на программирование ^^

Вот как только я читаю что-то типа "слой бизнес-логики", сразу думается "ну это не от жизни/практики, а так, теорехтически" :)

Итак, стукнуло мне в голову написать сценарий (вряд ли, но допустим). И вот беру я Вашу могучую софтину и.... и.... А что она делает ??? Никакой инфы нет. Ну может и есть, но так закопано в общих фразах что я ничего не понял. Ф-ционал-то где?

gil9red, вот списки идей: 1 (https://drive.google.com/open?id=1T6exNyVp1hRFfxuFLKlwrv4kHIBaEBeZCit_wYz1Erw&authuser=0), 2 (https://drive.google.com/file/d/0B-UEq5VPu5VwQ25WMGFrb3RjZGM/view?usp=sharing), 3 (https://drive.google.com/file/d/0B-UEq5VPu5VwYTVaaVdReGtwX00/view?usp=sharing), 4 (https://drive.google.com/file/d/0B-UEq5VPu5VwczYwcnR6V1ByQWc/view?usp=sharing). Они конечно не отфильтрованы, потому что я из разгребаю по мере реализации повестки дня. Сейчас на повестке дня у меня реализация возможности совместной работы над сценарием, а-ля гугл докс. Так что если будет желание дайте мне знать, что вы хотите сделать, чтобы я посмотрел имеет ли данный функционал смысл, и как эту идею можно подать в контексте нашего проекта.

Igors, как видите нет, в мае стартует разработка родственного проекта, для режиссёров и продюсеров, он как раз будет использовать уже все готовые наработки и главным образом бизнес логику ;) И это не фантазии, это опыт предыдущих проектов.

Что касается функционала, то можете глянуть на сайте программы kitscenarist.ru (http://kitscenarist.ru), там же есть видео для сценаристов, кто хочет начать работать с программой, а так же подробная-приподробная справка, где описан весь функционал.

Ссылка 3 и 4 особенно много располагают :) Я их до конца не прочел -- реально много )
Проще было бы вам с вашими товарищими определиться, что вы хотите сделать и составить файл TODO и в нем внести все, что хотите сделать, а этот файл хранить в проекте на гитхабе

А так, идей много, и они интересные, но их нужно разбить на более мелкие задачи :)

gil9red, нууу, сценаристов хлебом не корми, дай пофантазировать :) идеями обложили на 5 лет вперёд!

А в общем у меня есть своё видение пути развития:
- синхронизация/совместная работа;
- режим рецензирования;
- импорт/экспорт в DOCX текста совместно с редакторскими пометками;
- карточки/таймлайн;
- статистика по сценарию/графики/отчёты и т.п.;
- разработка сценария - конструкторы сюжета и персонажей.

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

Вот не надо им это. ;)
И так смотреть нечего, а с такими конструкторами будет совсем однотипно. :)

Old, здравствуйте. Не-не, эти конструкторы не будут "думать за сценариста", а лишь направлять его, помогать ему расшевелить фантазию, сбивать с инерции мышления и всё в таком роде. Так что наоборот должно будет появляться всё больше и больше стоящих картин!  ;)

Приветствую, коллеги.

Продолжим наше знакомство и сегодня поговорим о слое Модель предметной области.

Модель предметной области предназначена для сокрытия базы данных от верхних слоёв приложения, т.е. в приложении мы работаем с объектами (сценарием, персонажами, локациями и т.п.), а не с записями из базы.

Что внутри? Устройство слоя.

Давайте рассмотрим, как устроена логика работы слоя.
(http://kitscenarist.ru/assets/images/dev/02_domain_model_abstract.png)

DomainObject - базовый класс для всех объектов модели предметной области. Т.к. объекты являются отражениями данных из базы, то они содержат поле идентификации (Identifier - обёртка над идентификатором записи из базы данных), методы для работы с ним, а так же вспомогательный функционал для отслеживания изменений объекта.

DomainObjectsItemModel - базовый класс для списков объектов. Наследуется от родной модели Qt, реализуя основной функционал и немного расширяет её. Это позволяет использовать преимущества, как самой модели предметной области, так и техники Qt Model/View Programming.

ConcreteObject и ConcreteObjectsItemModel здесь - это реальные представители модели предметной области.

Что внутри? Классы.

А вот и диаграмма со всеми представителями слоя.
(http://kitscenarist.ru/assets/images/dev/03_domain_model_classes.png)

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

Вот примерно так и организована модель предметной области в моём приложении.

Как обычно, если у вас нашлись вопросы или замечания, буду очень рад обсудить их!

История с uml-диаграммами не пошла у меня самого :)

А проект тем временем значительно подрос. На сегодня зафиксировано более 7000 установок и около 800 постоянных пользователей!

Может быть вам будет интересно узнать, или обсудить реализации каких-нибудь возможностей?

Из того, что планировал уже реализовал:
- возможность размещения проекта в облаке и совместной работы над ним в режиме реального времени (а-ля гугл докс (https://www.youtube.com/watch?v=WXzXL_axhyw));
- режим рецензирования (т.е. можно выделять текст и оставлять к нему комментарии, вести обсуждения этих комментариев, помечать их как выполненные);

(http://kitscenarist.ru/assets/images/news/real-review.png)

- импорт/экспорт в DOCX текста совместно с редакторскими пометками;
- статистика по сценарию/графики/отчёты и т.п.;

(http://kitscenarist.ru/assets/images/news/summary-report.png)

(http://kitscenarist.ru/assets/images/news/plotting.png)

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

(http://kitscenarist.ru/assets/images/news/research.png)

Плюс немного освежил интерфейс программы и выпустил версию под Android.

(https://kitscenarist.ru/assets/images/news/android-login.png)

А! Ещё хорошие люди помогли сделать испанский и французский переводы!:)

(http://kitscenarist.ru/assets/images/news/es-version1.png)

Классно :)
А как и через что работа в облаке реализована?

Прикольно. Инструментарий разработки какой?

gil9red, спасибо.

Работа в облаке организована таким образом:
1. Развёрнут сервер, на котором крутится база данных и разработано api для доступа к ней.
2. Раз в пять секунд программа формирует патч с изменением (если оно было) и отправляет его на сервер, по пути забирая патчи от других активных в этот момент пользователей.
3. Патчи накладываются, происходит обновление текста и по-новой пункт 1.

Всю работу с формированием патчей, их наложением и т.п. делает библиотека google-diff-match-patch (https://code.google.com/archive/p/google-diff-match-patch/). Я лишь добавил к ней небольшой вспомогательный класс, который позволяет использовать её для работы с xml.

panAlexey, спасибо. Настольная и мобильная версия - всё полностью на Qt, веб-часть на php.

Ребята, привет!

У нас на днях был зафиксирована десятитысячный пользователь! Проект растёт и развивается, в связи с чем ищу помощника. Очень мощный фидбек, плюс много собственных идей, что хотелось бы доделать или добавить нового и сам я уже не справляюсь...

Если вы хотите поучаствовать в проекте, то пишите, обсудим детали, задачи, стоимость работ.

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

Сотрудничество я вижу себе так:
1. Я ставлю задачу.
2. Вы изучаете код - оцениваете.
3. Вы предлагаете способ реализации - мы его обсуждаем.
4. Если меня всё устраивает - вы реализуете задачу и делаете pull request на github.
5. Я делаю ревью, если всё в порядке, то рассчитываемся и переходим к следующей задаче, если нет, то вносите доработки или заканчиваем отношения.

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

Что касается самих задач - это не будут только исправления ошибок. Это будет довольно широкий спектр задач. Например в первую очередь я бы хотел отдать вам на доработки модуль "Разработка". По сути, это банальный органайзер - дерево разнородных документов.
(https://kitscenarist.ru/assets/images/news/research.png)
Что нужно будет сделать:
1. Реализовать перетаскивание элементов в дереве.
2. Реализовать фильтрацию элементов дерева.
3. Доработки виджета галереии изображений
3.1. Сделать возможность перемещаться к следующей фотке в режиме просмотра выбранной фотографии (такие стрелки влево-вправо по краям).
3.2. Сделать возможность drag&drop'а изображений в галерею из папок на компьютере и из браузера.
4. Найти легковесный опенсорсный редактор ментальных карт на Qt и встроить его в программу. Так, чтобы в разработке можно было создавать ментальные карты и редактировать их.

Пока всё :) Если будут вопросы, или желание поучаствовать - пишите, обсудим.

Привет, коллеги! Решил освежить ветку - вдруг кому будет интересна дальнейшая судьба проекта!:)

Количество установок программы уже давно перевалило за 20 тысяч! В прошлом году ко мне присоединился ещё один разработчик - студент МГУ, который в своё свободное время тоже участвует в разработке. За прошедший год мы основательно улучшили облачный сервис, значительно развили модули разработки, редактора сценария и статистики, сделали кучу небольших, но полезных улучшений, всякие автоматические обновления и т.п. вещи, добавили модуль карточек, а потом полностью его переделали!:D Программа была переведена ещё на 4 языка (немецкий, казахский, португальский и украинский), в работе переводы на китайский, японский и фарси.

Вот, даже сделали небольшое видео об основных возможностях: https://www.youtube.com/watch?v=zg-BLExGWzE

Короче жизнь кипит!:)

Если вам будет интересно узнать что-нибудь о проекте в подробностях, то с удовольствием расскажу! Ну а если вы вдруг захотите стать соучастником, то добро пожаловать! А если решите скачать и попробовать - не удивляйтесь, в программе серьёзно доработан интерфейс в сравнении с версией на видео!

Весёлого дня, ребята!

Давно о вас не слышно было :)

Да как-то не было спроса, вот мы и не маячим :)

Кстати, там у нас в проекте, родилась целая куча полезностей, может быть кому будет интересно - https://github.com/dimkanovikov/KITScenaristCore/tree/master/3rd_party/Widgets

Там есть много всего интересного, начиная от лайнэдита для ввода пароля, который имеет иконку "глазика" для отображения/скрытия символов пароля, редакторов текста с проверкой орфографии, заканчивая расширениями для анимации виджетов и коллекцией LightBox виджетов и диалогов, для реализации одноимённого эффекта (https://www.google.ru/search?q=LightBox&newwindow=1&source=lnms&tbm=isch&sa=X&ved=0ahUKEwickOOs6oLUAhVlM5oKHX4wD_IQ_AUICigB&biw=1920&bih=969#newwindow=1&tbm=isch&q=lightbox+dialog).

Там не всё конечно наше, есть и заимствованные вещи, но в любом случае может быть полезной "библиотекой" расширений.

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

xokc, спасибо за совет! Просто это как бы внутренняя папка проекта со вспомогательными вещами, как-то даже не задумывался о том, чтобы туда ридми добавить)

Привет, ребята! А мы на днях запилили мобильную версию программы и опубликовали в магазинах приложений Android (https://play.google.com/store/apps/details?id=pro.dimkanovikov.kit.scenarist) и iOS (https://itunes.apple.com/ru/app/kit-scenarist-screenplay-editor/id1268390257?l=ru&ls=1&mt=8)!

Igors, к давнишнему разговору про бизнес логику и прочее. В данном случае мы просто вынесли всё это в отдельный репозиторий, написали обвязку в виде слоя контроллеров и представлений и вуаля - приложение готово ;)

А вот как выглядит вся эта красота:

(https://kitscenarist.ru/assets/images/news/app_presentation_ru.png)

Ребята, всем привет!

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

В связи с чем, вновь объявляется поиск разработчиков для участия в проекте! Мне интересны ребята, которые умеют решать задачи. Если у вас нет большого опыта, то это ничего, я помогу во всём разобраться + постоянно делаю ревью, подсказываю в каких-то моментах. Главное, чтобы вам самим было интересно в этом поучаствовать и вы умели добиться результата. Ну а если есть большой опыт и вы хотите стать частью нашего проекта - круто! Есть очень много разноплановых задач. Куча задач по доработке самого приложения: тут и вещи связанные с GUI (чисто интерфейсные задачи, типа сделать фильтрацию в дереве, разработки графических редакторов [редактор схем, таймлайн], и другие [сейчас например есть желаение сделать диф-тулзу для сравнения версий сценариев]) и оптимизации/переработки некоторых алгоритмов, парсеры, есть задачки связанные с сетевым взаимодействием приложения и облачным сервисом; на бэкэнде нашего облачного сервиса тоже есть куда идей для развития. В общем не заскучаешь!

Технологии, которые сейчас используем: desktop & mobile - Qt (GUI на QtWidgets), web - php (если вы захотите переписать сервис на go или node js - да пожалуйста, тут полная свобода).

На всякий случай продублирую ссылку на исходники https://github.com/dimkanovikov/KITScenarist

P.S. Студент, который вместе со мной развивает проект, устроился на стажировку в компанию мечты! Не то, чтобы я в этом виноват, но как приятно быть причастным!:)