Warning: This document is for the development version of Bareos Documentation. The main version is bareos-23.

Documentation Style Guide

• Introduction
• reST Overview
  • Use of whitespace
  • Sphinx naming
    • Role
    • Directive
    • Domain
  • Paragraphs
  • Inline markup
  • Lists, Definition Lists and Quotes
  • Literal block
  • Source Code
  • Hyperlinks
    • External links
    • Internal links
  • Cross-linking markup
  • Sections
  • Explicit Markup
    • Directives
    • Comments
  • File/Directory/Path
  • Note
  • Warning
  • Quote
  • Index
    • .. index::
    • :index:
    • Converted (Latex2Sphinx) Indices
  • Image
  • Table
• Common Names
  • Bareos Names
  • Bareos Paths and Filenames
  • NDMP
  • Products
• Specific Formatting
  • Configuration
    • Configuration File
    • Configuration Directive
  • System Command
  • Unix Command Session
    • Unix Commmand Prompt
  • Windows
    • Windows Registry Key
  • Environment Variable
  • SQL
  • Logging
  • Name
  • Volume Parameter
  • Operating System
  • Email Address
  • Backus–Naur form
  • Diagrams
    • A block diagram
    • An activity diagram
    • A sequence diagram
    • A network diagram
    • Any PlantUML diagram
• Bareos Specific Formatting
  • Document File Structure
  • Bareos Host Names
  • Bareos Configuration
    • Bareos Configuration Resource
    • Resource Type
    • Resource Name
    • Resource Directive
      • Resource Directive Definition
      • Reference to a Resource Directive
      • Resource Directive With Value
  • Bconsole
    • Bconsole Command
    • Bconsole session
  • Bareos Logging
  • Limitation
  • Issues tracked on Mantis
    • bugs.bareos.org
    • Github
      • Pull request
      • Commit
  • Releases
    • Functional Changes
      • Note
    • Release Notes
    • Reference to a Release
    • URLs
      • Release URL - Bareos.org
      • Release URL - Bareos.com
      • Contributions Download URL
• Gotchas
  • sphinx-build
  • Not shown text
  • Undefined link targets
  • toctree vs include
    • include
    • toctree
  • :option: