Стаття

Новини та Корисні статті

Наші послуги


Oops, an error occurred! Code: 20200913075244397a14c1

Короткий звіт про семінар - Документація 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