Git Product home page Git Product logo

doc-admin's Introduction

OTRS Administrator's Manual

This repository contains the sources of the OTRS admin manual. They are located in en/ and stored in docbook format. The other languages are automatically generated with the help of po4a and the translation files in i18n.

How to Generate HTML from the Sources

You need to install the xsltproc and docbook-xsl packages (names may vary depending on your distribution).

Then you can run

cd /tmp
xsltproc --xinclude /usr/share/xsl/docbook-xsl/html/chunk.xsl /path/to/doc-admin/en/book.xml

The paths may vary, on MacOS docbook-xsl is located in /opt/local/xsl/...

How to Validate the Sources

You need to install the xmllint and docbook-xml packages.

Then you can run

xmllint --postvalid --nonet --xinclude --noout /path/to/doc-admin/en/book.xml

You will see some errors like

content/administration/ticket/states.xml:154: element link: validity error : IDREF attribute linkend references an unknown ID "Ticket:Frontend::Agent::Ticket::ViewEmailNew:Ticket::Frontend::AgentTicketEmail_StateDefault"

These are not problematic as a part of the admin manual is autogenerated - the configuration parameter reference. If you only see these link validity errors everything should be fine.

Generating Translation Sources Manually

If you add any new files, make sure to include them in po4a.conf.

Then you can run

po4a -v -k0 /path/to/doc-admin/po4a.conf

The command will generate files for all supported languages.

Translating the Sources

Please refer to http://doc.otrs.org/developer/stable/en/html/translating-docs.html.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.