Publikacja bloga DITA za pośrednictwem iiRDS do c-rex.net IDS

DITA jako źródło danych

W poprzednich artykułach opisaliśmy, że w naszym dziale redakcyjnym polegamy na DITA jako formacie autorskim.

Teraz odpowiadamy na pytanie, jak zasilić blog c-rex.net z naszej zawartości wzbogaconej o metadane.

Ponieważ opieramy się na DITA, sensowne jest używanie DITA Open Tool Kit do publikowania. Najpierw konwertujemy zawartość do iiRDS, a następnie publikujemy ją na c-rex.net IDS.

W tym celu opracowaliśmy zestaw wtyczek. Wtyczki, które pozwalają nam publikować za naciśnięciem jednego przycisku.

DITA-OT Plugins

Poniższa grafika przedstawia wtyczki dla DITA Open Tool Kit, które są używane w naszym środowisku redakcyjnym.

W przypadku Content Delivery treści istotne są wtyczki 3+1:

• com.c-rex.net.dita.dts

  Ta wtyczka zapewnia podstawową funkcjonalność do komunikacji z usługą w chmurze c-rex.net DTS. Zapewnia podstawowe parametry uwierzytelniania w systemie i konwersji.

• com.c-rex.net.dita.packager

  Packager to wtyczka ogólnego przeznaczenia, która pakuje zawartość DITA-Map do pakietu ZIP w celu wysłania zawartości do c-rex.net DTS w celu konwersji, zgodnie z wymaganiami tego przypadku użycia.

• com.crex.net.dita.conversion

  Wtyczka zapewnia parametry do konwersji treści DITA na inne formaty. Wtyczka implementuje dwa scenariusze transformacji DITA 2 iiRDS i DITA 2 c-rex.net IDS.

• com.crex.net.dita.td.content

  Jest to specjalna wtyczka dla wyspecjalizowanych typów tematów c-rex.net i implementacji specjalnych wymagań.

  Implementujemy w nim określone metadane w naszych wpisach na blogu, aby mogły być odpowiednio rozpoznawane po przekonwertowaniu na iiRDS przez c-rex.net DTS i przeniesieniu do formatu iiRDS.

  Ta wtyczka lub jej odmiana może być używana w różnych scenariuszach w celu dostosowania wymagań klienta do generowanego kodu HTML lub zestawu metadanych, które mają być generowane w odpowiednio zautomatyzowany sposób.

DITA-OT Conversion Plugin

DITA-OT Conversion Plugin zapewnia dwie funkcje:

• Przypadek 1: Generowanie pakietu iiRDS do wykorzystania w innych scenariuszach

• Przypadek 2: Publikacja treści za pośrednictwem iiRDS na c-rex.net IDS w różnych scenariuszach dostarczania treści

Ponieważ chcemy bezpośrednio publikować nasze posty na blogu, skupimy się na drugim przypadku użycia, a jedyną różnicą jest to, czy iiRDS jest dostarczany z powrotem do klienta, czy publikowany bezpośrednio.

Konfiguracja i parametry

Aby korzystać z usług konwersji c-rex.net DTS i opcji publikowania c-rex.net IDS, wymagane jest konto użytkownika i odpowiednie uprawnienia. Wprowadzając dane dostępu, wywołanie scenariusza transformacji jest konfigurowane we wtyczce. W poniższym oknie dialogowym zobaczysz niezbędne do tego parametry.

Aby wykonać scenariusz transformacji, należy ustawić następujące parametry.

• conversionType.param służy do określenia scenariusza DTS, z którym DTS ma przeprowadzić konwersję. W tym przypadku DITA-Map ma zostać opublikowana w c-rex.net IDS, dla którego ustawiony jest scenariusz ditaot2crexIDS.

• Parametr organisation organization.param param służy do określenia organizacji, w ramach której ma zostać opublikowany pakiet iiRDS.

  Prawa dostępu do treści mogą być kontrolowane przez organizację.

• Parametr dts.url.param param służy do określenia punktu końcowego usługi DTS, za pośrednictwem której ma zostać przeprowadzona konwersja. Zaprojektowany jako usługa w chmurze, wiele instancji jest naturalnie dostępnych w Internecie lub intranecie.

• Wreszcie, trzy identity są używane do określenia danych użytkownika, takich jak nazwa użytkownika i hasło, a także Scope wymaganego przez usługę uwierzytelniania.

  Wszystkie te informacje są dostępne w odpowiednim profilu użytkownika po zarejestrowaniu się w systemie.

Po skonfigurowaniu dostępu w systemie i wprowadzeniu tego ustawienia, dowolna DITA-Map może zostać opublikowana w portalu c-rex.net IDS za pomocą jednego kliknięcia "Wykonaj transformację".

Przygotowanie danych

DITA-OT-Plugin OT przygotowuje dane do konwersji po stronie serwera. Wszystkie DITA-Topics są opcjonalnie przekształcane do HTML5 lub XHTML5 za pomocą funkcji DITA-OT.

Ponieważ nasze wtyczki można płynnie zintegrować ze środowiskiem DITA-OT, ma to tę wielką zaletę, że automatycznie poprzednie rozszerzenia do generowania treści HTML mogą być używane bezpośrednio i bez dalszych dostosowań.

Tak jest w przypadku naszego środowiska blogowego i będzie to łatwe do wdrożenia również w Twoim!

Wreszcie, korzystamy również z tego mechanizmu, używając naszej własnej wtyczki com.crex.net.dita.td.content do przygotowania stron HTML.

Oprócz generowania HTML, podstawowe metadane są automatycznie dodawane do DITA-Map, a odniesienia do DITA-Topics są zmieniane na nową nazwę pliku wyjściowego HTML. Ten generator jest teraz przekazywany do c-rex.net DTSc-rex.net DTS z kolei kompiluje informacje do prawidłowego iiRDS i publikuje go automatycznie.

Metadane automatycznie rozszerzane w odniesieniach do tematów na DITA-Map mogą być dodawane automatycznie za pomocą oddzielnej DITA-OT-Plugin, takiej jak com.crex.net.dita.td.content. Alternatywnie, możliwe jest również przekazanie konfiguracji, która umożliwia usłudze DTS wykonanie mapowania określonego zestawu metadanych.

Transformacja zgodnie z iiRDS

Za pomocą przekazanego mapowania lub metadata iiRDS już wygenerowanych w sekcji , c-rex.net DTS generuje prawidłowy pakiet . Warunki określone w normie są sprawdzane, w miarę możliwości automatycznie korygowane i publikowane. Wszelkie problemy są zwracane w szczegółowym raporcie.

Oprócz raportu zwracany jest również pakiet iiRDS. Pakiet ten może być archiwizowany za pomocą istniejących mechanizmów archiwizacji w firmie.

Dzięki temu dane generowane przez system są dostępne przez cały czas i niezależnie od systemu.

Dla firm, dla których realizujemy projekty z iiRDS, oznacza to: Rozbijamy silosy i przywracamy naszym klienci kontrolę nad ich danymi.

Publikacja na portalu

Gotowy pakiet iiRDS jest udostępniany c-rex.net IDS za pośrednictwem Content API w celu publikacji.

Zawartość pakietu jest importowana do repozytorium organizacji określonej w parametrze. Dzięki temu treści są dostępne do użytku na portalu w ciągu kilku minut lub nawet sekund.

Wnioski

Przy niewielkim wysiłku dzięki integracji naszych wtyczek i minimalnej wymaganej konfiguracji, nasze treści utworzone za pomocą DITA są dostępne na naszej stronie internetowej w bardzo krótkim czasie.

Niemal niemożliwe jest szybsze i mniej pracochłonne udostępnianie treści w sieci w oparciu o technologię Linked Data Data.

Fajną rzeczą jest to, że działa to nie tylko w przypadku naszego bloga, który jest oparty na DITA, ale analogicznie do dokumentów utworzonych w Word, FrameMaker lub InDesign. Dostarcz konfigurację mapowania metadanych wraz z dokumentami, a c-rex.net DTS zajmie się resztą.