3. Провести тестирование результатов;
4. Доработать обеспечение основываясь на полученном из тестирования опыте;
5. Поднять при помощи docker-compose созданные сервисы;
6. Настроить сервис mediawiki, наладить взаимодействие c сервисом database
7. Подключить необходимые расширения
8. Создать сопроводительную документацию
9. Записать видео по рабочему процессу конвертера
10. Опубликовать исходный код и сопровождающую документацию на ресурсе github
Вдобавок к этому, данный проект можно разделить на две основные части.
Первая часть носит исследовательский характер. Она включает в себя исследование, анализ и обобщение основных и возможных методов реализации. Основной целью данного исследования является составление алгоритма дальнейших действий.
Вторая часть является более сложной для выполнения, и состоит в том, чтобы разработать заявленное программное средство, опираясь на все существующие требования. Более того, необходимо произвести тестирование полученных результатов, по чьим результатам выполнить доработку, а также выявить недостатки.
При выполнении второй части необходимо учитывать, что проект на финальной стадии должен быть полностью упакован и может быть установлен любым пользователем, нуждающимся в соответствующем инструментарии.
Требуется учитывать, что вики - место аккумуляции ноу-хау и результатов разработок. Там должны сохраняться как элементы технического знания для их обезличенной передачи всем нуждающимся (например, howto по подготовке к трансляции, примеры кода для решения какой-то типовой, часто повторяющейся задачи), так и отчеты по курсовым и дипломным работам. Таким образом, новые участники в проектах смогут продолжать с почти того же уровня, на каком закончили работу их предшественники, не приходилось «с нуля» вводить студентов в курс всех пластов задач, они знали, где взять необходимую информацию - от “как это сделать” до “какой IP у такого-то сервера”.
Таким образом, необходимо поддержать нагрузку на систему в размере от 300 новых уникальных пользователей в год. Входными параметрами для разработки являются непосредственно пользователи MediaWiki и вики-страницы, созданные в этом вики-проекте. Выходным параметром требуется считать уже обновленные после обработки в Google Documents вики-страницы.
6.Анализ предметной области
конвертер редактирование проект
Методология Wiki
В последнее время значительное количество исследований было посвящено проблеме использования и взаимодействия медиа культуры. В этой части проекта будут рассмотрены различные способы использования вики-движка для проектов. Прежде всего, необходимо уточнить, что этот движок, был написан специально для Википедии и используется во многих других проектах описанного фонда. Вики - это бесплатное серверное программное обеспечение. Для создания страниц используется текстовый формат Вики, поэтому пользователи могут легко их редактировать. Веб-сайты, основанные на вики-движке, сегодня широко распространены. Префикс Wiki (иногда постфикс) уже стал нарицательным. Так что для постоянных пользователей практически нет разницы между Википедией и любым веб-сайтом «вики». В этой среде люди могут создавать простой в использовании контент. Но финальный продукт требует изучения синтаксиса языка разметки. Тем не менее, вики-движок можно использовать для других целей. Именно эта функция управления медиа позволяет использовать движок для работы в группах (в классе). Однако у современной вики-технологии есть несколько проблем в том, как поддерживать совместную работу, например, как члены команды координируют свои действия друг с другом.
Вики предоставляют пользователям средства для простого добавления и редактирования контента: все, что требуется от пользователя, это иметь знания вики-разметки и веб браузер. Таким образом, пользователи могут публиковать контент без обращения к веб-мастерам. Другими словами, Вики - это веб-сайт, на котором пользователи могут изменять содержимое свободно, путем редактирования или удаления информации, пользуясь специальными инструментами, которые предоставляет веб-сайт. Более того, исправление текста и любой другой информации, содержащейся на сайте, возможно выполнить при помощи вики-разметки. Вики-разметка представляет собой язык разметки, который может быть применим для придания тексту определенного вида, а также она в разы упрощает подход к использованию языка программирования HTML. Веб-страницы, созданные при помощи вики-разметки конвертируются в HTML, для возможности просмотра страниц в веб-браузере. Данное преобразование реализуется при помощи специального программного средства под названием вики-движок.
Всего можно выделить три главных категории реализации вики технологий:
1. Публичные;
2. Корпоративные;
3. Персональные.
В связи с тем, что производится подробный анализ методологий вики, необходимо подробнее исследовать каждый из этих видов.
1. Публичные вики отличаются от других тем, что данный вид технологии предоставляет возможность внесения правок каждому пользователю. Такие вики создаются различными сообществами посетителей веб-сайта. Одним из самый известных примеров применения и реализации такого вида технологии является энциклопедия Википедия.
2. Корпоративные вики используются в различных компаниях для сохранения и обмена информации между сотрудниками той или иной организации. Яркими примерами текущего вида технологии принято считать Intel и Microsoft.
3. Персональные вики служат для пользования одним пользователем, который в свою очередь может вести формирование дневника или каких-либо заметок.
Вики дает возможность абсолютно всем пользователям изменять какую угодно страницу, а также создавать новые. При это, пользователю достаточно пользоваться обычным веб-браузером, совсем не обязательно использовать различные расширения. Вдобавок, вики поддерживает соединение между другими веб-страницами. Это происходит благодаря практически автономному формированию ссылок. Основой для работы веб-сайта вики является привлечение новых посетителей с целью продолжения процесса беспрерывного создания и изменения сайта.
Таким образом, по произведенному анализу методологий вики, можно прийти к выводу, сможет ли программный инструментарий, описанный в этой работе, быть реализован, используя вики основу.
7.Методология Google Documents.
Не менее мало важной частью текущего проекта является такой онлайн-офис, как Google Документы. Документы Google - это программное обеспечение, работающее в веб-браузере, при этом без установки на компьютер пользователя. Отличительной особенностью данного онлайн-пакета офисных приложений, является то, что авторы редактируют документ, хранящийся в репозитории Google, с помощью простого браузерного редактора, разработанного с использованием методологии AJAX (фоновый обмен данными с браузера в веб-браузер). Пользователи регистрируются один раз в службе, а затем могут создавать документы и приглашать соавторов, которые могут обновить документ. Существует также пользователи категории «зритель»; они могут только читать документ. Изменения в документе автоматически передаются на сервер, это происходит примерно через 30 секунд, если возникает конфликт, конфликтующее изменение отменяется, и текущее состояние документа отображается вместе с сообщением, отображающим конфликтующий текст. При необходимости это можно повторно применить к документу.
Из-за высокой частоты применения обновлений к хранилищу конфликты маловероятны. Если конфликт действительно возникает, он, вероятно, будет очень незначительным, и поэтому с ним легко разобраться. Также, сохраняется обширная история изменений и у пользователя есть возможность просмотреть весь документ, как он изменялся в любое время. В связи с этим, автор может решить вернуться к более ранней версии документа, если возникают разногласия. Существуют также инструменты для сравнения любых двух версий документа, они могут быть сохранены на компьютер пользователя в различных форматах, таких как PDF, HTML и Microsoft Word. Пользуясь Google Документами для совместной работы , выяснилось, что интерфейс удобный, эффективный и действенный. Кроме того, было очень легко наладить сотрудничество с коллегами. Подводя итог, можно сделать вывод, что Google Документы является отличной платформой для совместной работы над созданием документов.
8.Анализ аналогичных методологий
конвертер редактирование проект
На сегодняшний день процесс создания различных веб-страниц определенно перешел на новый уровень, в связи с тем, что у пользователей появился огромный выбор различных программных редакторов и онлайн сайтов для создания своих веб-страниц в сети интернет. Поэтому необходимо разобраться в основных методах создания веб-страниц, а также выявить их недостатки. Сегодня существует три ключевых вида редактора, позволяющих работать с веб-страницами: онлайн редактор, офлайн редактор и визуальный редактор.
1. Онлайн редакторы представляют из себя сайты, которые создаются при помощи хостинга в интернете (хостингом является предоставление места для размещения информации на сервере). Более того, существует огромное множество различных шаблонов создания страниц, которые являются простыми в освоении и общедоступными к использованию.
2. Офлайн редакторы по своей сущности являются программами, которые устанавливаются на отдельный компьютер. В связи с этим главное отличие таких редакторов от предыдущего вида представляет собой привязанность к одному компьютеру (такой компьютер не обязательно должен быть оснащен доступом в интернет). Главным преимуществом текущего вида редакторов является то, что такие программы позволяют пользователю создавать более трудные и многогранные проекты, не имея подключения к интернету (собственно, отсюда данный вид и берет свое название).
3. Следующим видом упомянутых редакторов является визуальный редактор. Текущий вид позволяет создавать веб-страницы, без большой необходимости в знаниях языка программирования HTML. Однако несмотря на свою простоту, такой тип редакторов будет полезен как для новых, так и для опытных пользователей.
К недостаткам визуальных редакторов можно отнести то, что веб-страницы, созданные по принципу таких редакторов, будут выглядеть просто и скромно. Это может оттолкнуть посетителей веб-страницы. В то время, как основным недостатком HTML редакторов будет являться сложность в исполнении. Пользователь, который выбрал исполнение веб-страницы при помощи HTML редактора должен изучить многие особенности языка программирования HTML, обычно данный вид редактора принято считать для профессионалов. Поэтому и был выбран визуальный редактор вики как рабочая среда для выполнения работы, из-за ее простоты и удобности использования.
В связи с тем, что существует огромное количество различных программных средств для реализации веб-страниц, сравним вики редактор с любым HTML редактором, например Dreamweaver (DW). DW относится к разряду лучших HTML редакторов создания веб-страниц, программа весьма многогранна и дает возможность пользователю писать от простых до действительно непростые конструкции для управления контентом. Пользовательский интерфейс оснащен внушительным рядом дополнительных функций, также присутствуют особенности присущие практически всем редактором на HTML, а именно подсветка синтаксиса и интеллектуальный ввод. Пример такого интерфейса представлен на рис. 1.
Рис. 1. Пользовательский интерфейс HTML редактора DreamWeaver.
Однако, как указывалось выше основной целью данной работы является разработка нового инструментального средства, способного упростить рабочий процесс пользователя. В связи с чем и была выбрана вики платформа как основание для создания двухстороннего конвертера.
9.Обзор решения
конвертер редактирование проект
Для того, чтобы реализуемое программное средство могло выполнять все поставленные требования и задачи, необходимо разобраться, как именно будет выглядеть работа инструмента. Разделим весь рабочий процесс на 5 шагов.
Шаг 1. Предоставляется ссылка для администратора (которым будет являться один из студентов, либо уполномоченное лицо), который в свою очередь создает учетную запись пользователя. Примечание: адрес электронной почты должен быть зарегистрирован в домене miem.hse.ru, для выдачи пользователю прав доступа на редактирование страниц через Google Documents.
Шаг 2. Установка дополнения. Пользователю необходимо установить дополнение, предоставляемое по ссылке и разрешить доступ к аккаунту Google.
Шаг 3. Создание страницы. Для создания страницы необходимо перейти в личный кабинет, нажав на имя пользователя в верхнем правом углу. Находясь в личном кабинете, перейти на страницу создания статьи, нажав на кнопку “Создать”. Информацию по разметке статьи можно найти, нажав на кнопку “Справка” в верхнем меню окна редактирования. При повторном редактировании статьи необходимо указать в специальном поле выполненные изменения для дальнейшего отслеживания версий статьи. Пример создания страницы представлен на рис. 2.
Рис. 2. Создание страницы на веб-сайте вики.
Шаг 4. Редактирование статьи в Google Documents. Для редактирования статьи непосредственно на Google Documents, необходимо нажать на интересующей вас странице нажать кнопку «Править» и перейти по ссылке “Edit in Google Docs”, расположенной внизу страницы выбранной статьи и быть авторизованным с помощью почты, указанной при регистрации аккаунта. Пример редактирования статьи представлен на рис. 3.
Рис. 3. Редактирование статьи на Google Documents.
Шаг 5. Выгрузка статьи. После завершения редактирования статьи необходимо перейти в верхнем меню Дополнения - Docs To Wiki Add-on Private - Публикация
В случае первичного использования расширения в появившемся боковом меню справа необходимо авторизоваться на сайте Вики и предоставить разрешение на выполнение следующих действий от Вашего имени на всех проектах этого сайта. В появившемся меню справа при необходимости добавьте описание изменений, либо поставьте отметку “Изменения незначительные”. После нажатия на кнопку “Загрузить страницу” исходная страница на Вики обновится в соответствии с итоговой версией документа на Google Documents.