|
ReStructuredText
reStructuredText (RST, ReST, or reST) is a file format for textual data used primarily in the Python programming language community for technical documentation. It is part of the Docutils project of the Python Doc-SIG (Documentation Special Interest Group), aimed at creating a set of tools for Python similar to Javadoc for Java or Plain Old Documentation (POD) for Perl. Docutils can extract comments and information from Python programs, and format them into various forms of program documentation. In this sense, reStructuredText is a lightweight markup language designed to be both (a) processable by documentation-processing software such as Docutils, and (b) easily readable by human programmers who are reading and writing Python source code. History reStructuredText evolved from an earlier lightweight markup language called StructuredText (developed by Zope). There were a number of problems with StructuredText, and reST was developed to address them. The name reStructuredText ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Lightweight Markup Language
A lightweight markup language (LML), also termed a simple or humane markup language, is a markup language with simple, unobtrusive syntax. It is designed to be easy to write using any generic text editor and easy to read in its raw form. Lightweight markup languages are used in applications where it may be necessary to read the raw document as well as the final rendered output. For instance, a person downloading a software library might prefer to read the documentation in a text editor rather than a web browser. Another application for such languages is to provide for data entry in web-based publishing, such as weblogs and wikis, where the input interface is a simple text box. The server software then converts the input into a common document markup language like HTML. History Lightweight markup languages were originally used on text-only displays which could not display characters in italics or bold, so informal methods to convey this information had to be developed. This ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Comparison Of Document-markup Languages
The following tables compare general and technical information for a number of document markup language, document markup languages. Please see the individual markup languages' articles for further information. General information Basic general information about the markup languages: creator, version, etc. Note: While Rich Text Format, Rich Text Format (RTF) is human readable, it is not considered to be a markup language and is thus excluded from the table. Characteristics Some characteristics of the markup languages. Notes See also * List of document markup languages * Comparison of Office Open XML and OpenDocument * Comparison of OpenXPS and PDF * Comparison of e-book formats * Comparison of data serialization formats Markup language comparisons, Document markup languages Markup languages, *Comparison of document markup languages {{Ebooks ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Sphinx (documentation Generator)
Sphinx is a documentation generator written and used by the Python community. It is written in Python, and also used in other environments. Purpose and function Sphinx converts reStructuredText files into HTML websites and other formats including PDF, EPub, Texinfo and man. reStructuredText is extensible, and Sphinx exploits its extensible nature through a number of extensions – for autogenerating documentation from source code, writing mathematical notation or highlighting source code, etc. HTML Themes Sphinx provides the ability to apply themes to HTML and HTML-based formats. Sphinx has several builtin themes including alabaster, classic, sphinxdoc, and scrolls. Popular themes that can be installed as Python modules include: * Read the Docs * Sphinx Bootstrap * Guzzle * Documatt History and use The first public release, version 0.1.61611, was announced on March 21, 2008. It was developed for, and is used extensively by, the Python project for documentation. Sin ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Comparison Of Note-taking Software
The tables below compare features of notable note-taking software. General information Basic features Advanced formatting and content See also * Comparison of text editors * Comparison of web annotation systems * Comparison of wiki software * Comparison of word processors * List of personal information managers * List of text editors * List of wiki software * Outliner * Personal information manager A personal information manager (often referred to as a PIM tool or, more simply, a PIM) is a type of application software that functions as a personal organizer. The acronym PIM is now, more commonly, used in reference to personal information manag ... * Personal knowledge base Notes References External links * {{DEFAULTSORT:Comparison Of Notetaking Software Notetaking software Note-taking Text editor comparisons ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Technical Documentation
Technical documentation is a generic term for the classes of information created to describe (in technical language) the use, functionality or architecture of a product, system or service. Classes of technical documentation Classes of technical documentation may include: * patents * specifications of item or of components/materials * data sheets of item or of components/materials * test methods * manufacturing standards * system requirements * system architecture * system design documents and data including those necessary for the system development, testing, manufacturing, operation and maintenance Standardizing technical documentation Historically, most classes of technical documentation lacked universal conformity (standards) for format, content and structure. Standards are being developed to redress this through bodies such as the International Organization for Standardization(ISO), which has published standards relating to rules for preparation of user guides, manuals, pr ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
CMake
In software development, CMake is cross-platform free and open-source software for build automation, testing, packaging and installation of software by using a compiler-independent method. CMake is not a build system itself; it generates another system's build files. It supports directory hierarchies and applications that depend on multiple libraries. It is used in conjunction with native build environments such as Make, Qt Creator, Ninja, Android Studio, Apple's Xcode, and Microsoft Visual Studio. It has minimal dependencies, requiring only a C++ compiler on its own build system. CMake is distributed as open-source software under a permissive BSD-3-Clause license. History CMake development began in 1999 in response to the need for a cross-platform build environment for the Insight Segmentation and Registration Toolkit. The project is funded by the United States National Library of Medicine as part of the Visible Human Project. It was partially inspired by pcmaker, which ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
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 language, DocBook enables its users to create document content in a presentation-neutral form that captures the logical structure of the content; that content can then be published in a variety of formats, including HTML, XHTML, EPUB, PDF, man pages, Web help and HTML Help, without requiring users to make any changes to the source. In other words, when a document is written in DocBook format it becomes easily portable into other formats, rather than needing to be rewritten. Design DocBook is an XML language. In its current version (5.x), DocBook's language is formally defined by a RELAX NG schema with integrated Schematron rules. (There are also W3C XML Schema+Schematron and Document Type Definition (DTD) versions of the schema available, ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Setext
Setext (Structure Enhanced Text) is a lightweight markup language used to format plain text documents such as e-newsletters, Usenet postings, and e-mails. In contrast to some other markup languages (such as HTML), the markup is easily readable without any parsing or special software. Setext was first introduced in 1991 by Ian Feldman for use in the '' TidBITS'' electronic newsletter. Purpose Setext allows viewing of marked-up documents without special viewing software. When appropriate software ''is'' used, however, a rich text-style experience is available to the user. Smaller documents are trivial to create in any text editor. To prevent errors, most large ''setext'' publications are created using a markup language such as HTML or SGML and then converted. The ''setext'' document can then be distributed without the need for the recipient to use a HTML email or web viewer. Multiple ''setext'' documents in the same file Multiple ''setext'' documents can be stored in the sa ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Project Gutenberg
Project Gutenberg (PG) is a volunteer effort to digitize and archive cultural works, as well as to "encourage the creation and distribution of eBooks." It was founded in 1971 by American writer Michael S. Hart and is the oldest digital library. Most of the items in its collection are the full texts of books or individual stories in the public domain. All files can be accessed for free under an open format layout, available on almost any computer. , Project Gutenberg had reached 50,000 items in its collection of free eBooks. The releases are available in plain text as well as other formats, such as HTML, PDF, EPUB, MOBI, and Plucker wherever possible. Most releases are in the English language, but many non-English works are also available. There are multiple affiliated projects that provide additional content, including region- and language-specific works. Project Gutenberg is closely affiliated with Distributed Proofreaders, an Internet-based community for proofread ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Trac
Trac is an open-source, web-based project management and bug tracking system. It has been adopted by a variety of organizations for use as a bug tracking system for both free and open-source software and proprietary projects and products. Trac integrates with major version control systems including ( "out of the box") Subversion and Git. Trac is used, among others, by the Internet Research Task Force, Django, FFmpeg, jQuery UI, WebKit, 0 A.D., and WordPress. Trac is available on all major operating systems including Windows via Installer or Bitnami, OS X via MacPorts or pkgsrc, Debian, Ubuntu, Arch Linux or FreeBSD, as well as on various cloud hosting services. History Inspired by CVSTrac, Jonas Borgström and Daniel Lundin from Edgewall Software started writing ''svntrac'' in August 2003 using SQLite and Subversion. In December 2003 they renamed it to ''Trac''. In February 2004 the Trac version was changed first from 0.0.1 to 0.1 and then directly from 0.1 to 0.5. That ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Comparison Of Documentation Generators
The following tables compare general and technical information for a number of documentation generators. Please see the individual products' articles for further information. Unless otherwise specified in footnotes, comparisons are based on the stable versions without any add-ons, extensions or external programs. Note that many of the generators listed are no longer maintained. General information Basic general information about the generators, including: creator or company, license, and price. Supported formats The output formats the generators can write. Other features See also * Code readability * Documentation generator * Literate programming Literate programming is a programming paradigm introduced in 1984 by Donald Knuth in which a computer program is given as an explanation of its logic in a natural language, such as English, interspersed (embedded) with snippets of macros and t ... * Self-documenting code Notes References {{DEFAULTSORT:Com ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
