Статья

Новости и Полезные статьи

Наши услуги


Команда документации TYPO3 приняла приглашение Клауса Дуэя на его семинар TYPO3 Fluid 3.0 в Орхусе, Дания.

Краткий отчет о семинаре - Документация TYPO3 Fluid 3.0

Logo

В этой статье рассказывается о семинаре Fluid 3.0. Кроме того, подробно о предстоящих планах Fluid.

История и текущее состояние

Fluid - это автономный шаблонизатор для веб-языка PHP. Первоначально он был разработан в рамках веб-платформы TYPO3 Flow, но теперь каждый может использовать Fluid. Он используется TYPO3 CMS, Flow и Neos.

Claus Due в текущем Объединение компонентов для Fluid отвечает за интеграцию с TYPO3 CMS. Таким образом, он отвечает за код Fluid, функциональность, обратную совместимость, архитектуру и будущее развитие.

До настоящего времени было мало документации, доступной только в Fluid repository on GitHub, без подробных сведений об использовании Fluid с TYPO3. Вот на этом мы сосредоточились на семинаре.

Workshop 3.0

Claus Due пригласил всех принять участие в Fluid 3.0. Предстоящий выпуск будет включать в себя серьезные изменения и вводит совершенно новые концепции. Эти концепции делают Fluid еще более гибким. Можно, например, принять Fluid для таких подходов к проектированию, как Atomic Design

На семинаре четыре волонтера из Команда по документации  сосредоточились на этих улучшениях документации Fluid.

Как документировать

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

Мы обсуждали Markdown, потому что это популярный метод форматирования текста. Однако в официальной документации TYPO3 используется reStructuredText (reST). Разметка похожа на reST, но у нее меньше функций и некоторые противоречивые особенности, когда она отображается в различных форматах. Вы можете прочитать о решении не использовать Markdown здесь: Написание документации

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

Улучшить XSD

XSD (определение схемы XML) - это технология XML, скрыто используемая. XSD включает автозаполнение в IDE и автоматически генерирует справку ViewHelper, которая уже создана для TYPO3 CMS 9.5 и Fluid 2.x. В текущей реализации были некоторые ограничения. Во время семинара нам удалось обойти это и приступить к реализации.

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

После завершения XSD будет передавать еще больше информации, например, разрешить PHP-типы в качестве аргументов для ViewHelper. Также будет возможно предоставить несколько возможных типов для аргумента. Это будет отражено в автоматически сгенерированном справочнике.

Написание документации

Без надлежащей документации гораздо сложнее начать работать с Fluid.

Проекты могут даже не рассматривать Fluid в качестве возможной альтернативы шаблонизатора из-за отсутствия документации. Поэтому мы начали строить документацию из существующих источников.

Мы начали с оглавления, добавив в существующую документацию от GitHub. Мы также имели в виду информацию на Flutytypo3.org.

Мы также добавили список разделов, ссылающихся на Fluid, на docs.typo3.org. В рамках «Планов на будущее» (см. Ниже) сообщество TYPO3 будет управлять этой документацией на docs.typo3.org.

Мы высоко ценим работу Усмана Ахмада и Итишри Гунхру по этой теме. Они запустили первую версию документации, основанную на существующих источниках.

Мы также высоко ценим работу Тома Уорика. Он собрал источники, упоминающие движок шаблонов Fluid в разных местах. Также спасибо за предоставленную информацию носителей языка.

Планы на будущее

Завершить XSD

Внедрение новых функций должно быть завершено. Еще несколько тестов и код должен быть написан. Кроме того, инструменты, работающие с XSD, такие как fluid-documentation-generator, в конце нуждаются в корректировке, чтобы использовать новую информацию. Инструмент для генерации XSD можно найти на GitHub.

Завершить первую версию документации

Работы еще много. Все источники должны быть объединены в систему документации. Это должно содержать всю информацию, чтобы начать с Fluid в качестве автономного шаблонизатора.

Кроме того, все существующие источники нуждаются в корректировке. Они должны ссылаться на официальную документацию по жидкости и предоставлять только более конкретную информацию сверху. В настоящее время планируется отказаться от Fluytypo3.org в пользу новой официальной документации на docs.typo3.org.

Говорим спасибо

Спасибо всем участникам. Мы знаем, что у некоторых из вас была действительно долгая дорога. Также большое спасибо гостеприимству Systime, за место проведения. Их завтрак, обед, напитки и атмосфера были действительно отличными. И, конечно, спасибо Claus Due за приглашение, предоставление самосваренного пива, самодельного кофе и серьезное отношение к документации. 

Если вы хотите помочь в любом из этих направлений, посетите эти ресурсы:

Получите больше информации на странице Команды документации TYPO3.

ЛогоНазваниеТипДемоСсылки
image
image