Mallard is a
markup language
Markup language refers to a text-encoding system consisting of a set of symbols inserted in a text document to control its structure, formatting, or the relationship between its parts. Markup is often used to control the display of the document ...
for the creation of help pages and user documentation for applications (technical
documentation
Documentation is any communicable material that is used to describe, explain or instruct regarding some attributes of an object, system or procedure, such as its parts, assembly, installation, maintenance and use. As a form of knowledge manageme ...
). Mallard 1.0 was released on 23 July 2013.
Mallard is an
XML
Extensible Markup Language (XML) is a markup language and file format for storing, transmitting, and reconstructing arbitrary data. It defines a set of rules for encoding documents in a format that is both human-readable and machine-readable. ...
language. Similar to
DocBook
DocBook is a semantic markup language for technical documentation. It was originally intended for writing technical documents related to computer hardware and software, but it can be used for any other sort of documentation.
As a semantic languag ...
, it defines the logical structure of a document.
The documents are then displayed in a help browser, which creates links between the documents.
Concepts such as guides and topics provide means for reaching help pages in different ways.
At the moment,
GNOME applications such as
Web
Web most often refers to:
* Spider web, a silken structure created by the animal
* World Wide Web or the Web, an Internet-based hypertext system
Web, WEB, or the Web may also refer to:
Computing
* WEB, a literate programming system created b ...
,
Eye of GNOME
Eye of GNOME is the official and default image viewer for the GNOME desktop environment, where it is also known as Image Viewer. There is also another official image viewer for GNOME called gThumb that has more advanced features like image orga ...
,
Evince
Evince (), also known as GNOME Document Viewer, is a free and open source document viewer supporting many document file formats including PDF, PostScript, DjVu, TIFF, XPS and DVI. It is designed for the GNOME desktop environment.
The de ...
and others use Mallard for documentation purposes.
Mallard is the preferred system for the Gnome Documentation.
Mallard pages can be viewed in ''Yelp'', a
GNOME help browser.
Further output formats are planned that can be generated via the command line using the tools that are provided via
Gitorious
Gitorious was a free and open source web application for hosting collaborative free and open-source
Free and open-source software (FOSS) is a term used to refer to groups of software consisting of both free software and open-source software ...
:
*
HTML
The HyperText Markup Language or HTML is the standard markup language for documents designed to be displayed in a web browser. It can be assisted by technologies such as Cascading Style Sheets (CSS) and scripting languages such as JavaScri ...
*
LaTeX
Latex is an emulsion (stable dispersion) of polymer microparticles in water. Latexes are found in nature, but synthetic latexes are common as well.
In nature, latex is found as a milky fluid found in 10% of all flowering plants (angiosper ...
*
Dot
References
{{reflist
External links
* http://projectmallard.org/ project Mallard main page
* https://github.com/projectmallard sources and tools at
GitHub
GitHub, Inc. () is an Internet hosting service for software development and version control using Git. It provides the distributed version control of Git plus access control, bug tracking, software feature requests, task management, co ...
GNOME
XML
Markup languages
Document-centric XML-based standards
Software documentation