Mallard (documentation)

Last updated

Mallard
Mallard XML logo.png
Filename extension .page
Developed by Shaun McCance
Type of format markup language
Extended from XML
Standard projectmallard.org
Mallard 1.0

Mallard is a markup language for the creation of help pages and user documentation for applications (technical documentation). Mallard 1.0 was released on 23 July 2013. [1]

Markup language modern system for annotating a document

In computer text processing, a markup language is a system for annotating a document in a way that is syntactically distinguishable from the text. The idea and terminology evolved from the "marking up" of paper manuscripts, i.e., the revision instructions by editors, traditionally written with a red or blue pencil on authors' manuscripts. In digital media this "blue pencil instruction text" was replaced by tags, which indicate what the parts of the document are, rather than details of how they might be shown on some display. This lets authors avoid formatting every instance of the same kind of thing redundantly. It also avoids the specification of fonts and dimensions, which may not apply to many users.

Documentation set of documents providing knowledge

Documentation is a set of documents provided on paper, or online, or on digital or analog media, such as audio tape or CDs. Examples are user guides, white papers, on-line help, quick-reference guides. It is becoming less common to see paper (hard-copy) documentation. Documentation is distributed via websites, software products, and other on-line applications.

Mallard is an XML language. Similar to DocBook, 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.

XML Markup language developed by the W3C for encoding of data

Extensible Markup Language (XML) is a markup language that defines a set of rules for encoding documents in a format that is both human-readable and machine-readable. The W3C's XML 1.0 Specification and several other related specifications—all of them free open standards—define XML.

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.

At the moment, GNOME applications such as Web, Eye of GNOME, Evince and others use Mallard for documentation purposes. Mallard is the preferred system for the Gnome Documentation. [2]

GNOME desktop environment and graphical user interface

GNOME is a free and open-source desktop environment for Unix-like operating systems. GNOME was originally an acronym for GNU Network Object Model Environment, but the acronym was dropped because it no longer reflected the vision of the GNOME project.

Eye of GNOME free image viewer software for the GNOME desktop environment

Eye of GNOME is the official image viewer for the GNOME desktop environment, where it is also known as Image Viewer. Eye of GNOME provides basic effects for improved viewing, such as zooming, full-screen, rotation, and transparent image background control.

Evince free software document viewer

Evince is a document viewer for PDF, PostScript, DjVu, TIFF, XPS and DVI formats. It was designed for the GNOME desktop environment.

Mallard pages can be viewed in Yelp, a GNOME help browser. [3] Further output formats are planned that can be generated via the command line using the tools that are provided via Gitorious:

Gitorious

Gitorious was a shared web hosting service for collaborative free and open-source software development projects that use the Git revision control system. The name also refers to the free and open-source server software that the Web site is developed and hosted on. According to the Git User's Survey in 2011, Gitorious was the second most popular hosting service for Git, with 11.7% of respondents indicating they use it, behind 87.5% using GitHub. On 3 March 2015, Gitorious was acquired by GitLab, who announced service through gitorious.org would be discontinued on 1 June 2015 and encouraged Gitorious users to make use of its import tools to migrate projects to GitLab.

Related Research Articles

JavaScript programming language

JavaScript, often abbreviated as JS, is a high-level, interpreted programming language that conforms to the ECMAScript specification. JavaScript has curly-bracket syntax, dynamic typing, prototype-based object-orientation, and first-class functions.

HTML Hypertext Markup Language

Hypertext Markup Language (HTML) is the standard markup language for creating web pages and web applications. With Cascading Style Sheets (CSS) and JavaScript, it forms a triad of cornerstone technologies for the World Wide Web.

Web pages authored using hypertext markup language (HTML) may contain multilingual text represented with the Unicode universal character set. Key to the relationship between Unicode and HTML is the relationship between the "document character set" which defines the set of characters that may be present in a HTML document and assigns numbers to them and the "external character encoding" or "charset" used to encode a given document as a sequence of bytes.

World Wide Web System of interlinked hypertext documents accessed over the Internet

The World Wide Web (WWW), commonly known as the Web, is an information space where documents and other web resources are identified by Uniform Resource Locators, which may be interlinked by hypertext, and are accessible over the Internet. The resources of the WWW may be accessed by users by a software application called a web browser.

XSLT is a language for transforming XML documents into other XML documents, or other formats such as HTML for web pages, plain text or XSL Formatting Objects, which may subsequently be converted to other formats, such as PDF, PostScript and PNG. XSLT 1.0 is widely supported in modern web browsers.

Gecko (software) free HTML layout engine

Gecko is a browser engine developed by Mozilla. It is used in the Firefox browser, the Thunderbird email client, and many other projects.

Wolfram Mathematica computational software program

Wolfram Mathematica is a modern technical computing system spanning most areas of technical computing - including neural networks, machine learning, image processing, geometry, data science, visualizations, and others. The system is used in many technical, scientific, engineering, mathematical, and computing fields. It was conceived by Stephen Wolfram and is developed by Wolfram Research of Champaign, Illinois. The Wolfram Language is the programming language used in Mathematica.

man page standard UNIX utility for reading manual pages

A man page is a form of software documentation usually found on a Unix or Unix-like operating system. Topics covered include computer programs, formal standards and conventions, and even abstract concepts. A user may invoke a man page by issuing the man command.

GNOME Web web browser from GNOME

GNOME Web is a free and open-source lightweight web browser developed by GNOME only for Linux and Unix-like systems.

gedit open source text editor of the Gnome project

gedit is the default text editor of the GNOME desktop environment and part of the GNOME Core Applications. Designed as a general-purpose text editor, gedit emphasizes simplicity and ease of use, with a clean and simple GUI, according to the philosophy of the GNOME project. It includes tools for editing source code and structured text such as markup languages.

Glade Interface Designer graphical rapid application development program

Glade Interface Designer is a graphical user interface builder for GTK+, with additional components for GNOME. In its third version, Glade is programming language–independent, and does not produce code for events, but rather an XML file that is then used with an appropriate binding. See List of language bindings for GTK+ for the available ones.

ScrollKeeper is a document cataloging system. It manages documentation metadata, as specified by the Open Source Metadata Framework (OMF). ScrollKeeper was used by the GNOME desktop help browser, Yelp, but has since been replaced by Rarian. It was also used by the KDE help browser and ScrollServer documentation server.

In computing, a keyboard shortcut is a sequence or combination of keystrokes on a computer keyboard which invokes commands in software.

Oracle Secure Global Desktop (SGD) software provides secure access to both published applications and published desktops running on Microsoft Windows, Unix, mainframe and System i systems via a variety of clients ranging from fat PCs to thin clients such as Sun Rays.

GNOME Devhelp free software

Devhelp is a GTK+/GNOME browser for API documentation; it works natively with gtk-doc.

ActiveX Document is a Microsoft technology that allows users to view and edit Microsoft Word, Excel, and PDF documents inside web browsers. It defines a set of Component Object Model coding contracts between hosting programs like Internet Explorer or Microsoft Office Binder and hosted documents from programs like Microsoft Word, Microsoft Excel and Adobe Reader. This allows them to negotiate communications about commands like save and navigate, as well as merging user interface elements such as menu, to provide a unified user experience.

Rarian is a document cataloging system. It manages documentation metadata, as specified by the Open Source Metadata Framework (OMF). Rarian is used by the GNOME desktop help browser, Yelp. It has replaced ScrollKeeper, as originally designed. It provides an API.

Mono (software) computer software project

Mono is a free and open-source project to create an Ecma standard-compliant .NET Framework-compatible software framework, including a C# compiler and a Common Language Runtime. Originally by Ximian, it was later acquired by Novell, and is now being led by Xamarin, a subsidiary of Microsoft and the .NET Foundation. The stated purpose of Mono is not only to be able to run Microsoft .NET applications cross-platform, but also to bring better development tools to Linux developers. Mono can be run on many software systems including Android, most Linux distributions, BSD, macOS, Windows, Solaris, and even some game consoles such as PlayStation 3, Wii, and Xbox 360.

References

  1. "Mallard 1.0" . Retrieved 16 October 2013.
  2. Gnome Documentation Project's Roadmap
  3. "Using Mallard with Yelp" . Retrieved 16 October 2013.

GitHub is a web-based hosting service for version control using Git. It is mostly used for computer code. It offers all of the distributed version control and source code management (SCM) functionality of Git as well as adding its own features.