Documentation

From Gnash Project Wiki

Jump to: navigation, search
  • Lenguaje/Language/Langue

|| DE:Deutsch | English | Español | Français | RU:Русский | IT:Italiano | Team ||

The beta Gnash manual is available here: http://www.gnashdev.org/?q=node/26

Please see target.http://www.crashandmushi.com/gnash/index.html for documentation pieces that are not in DocBook XML, and therefore aren't necessarily appropriate for CVS.

Contents

Gnash Documentation

Current Gnash Manual Outline

  1. Intro
    1. Gnash Overview
      1. Flash Support
  2. Using Gnash
    1. Gnash Command Line Options
    2. Gnash Interactive Control Keys
    3. User Configuration File
  3. Installing and Configuring Gnash
    1. Using a Package Manager
    2. Building From Source
      1. Getting the Source
      2. Code Dependencies
      3. Docs Dependencies
      4. Testing Dependencies
      5. Configuration
      6. Building From Source
      7. Installation
  4. Reporting Bugs
    1. Compile the latest Gnash build
    2. Determine if the bug was previously reported
    3. Review bug writing guidelines
    4. Filing a bug report
  5. Glossary
  6. Authors

Notes

The information above is essentially basic reference material. For future releases, I intend to provide a bit more explanation and examples. The existing content is also focused on a technical audience, and we'll need more information for an average, less technical end-user.

It seems that there should be two Developer's Guides: one for those who wish to develop Gnash, and one for those who wish to develop/author flash content according to the Gnash spec.

Proposed New Gnash Docs Outlines

Gnash Developer's Guide - This guide is meant to provide all technical reference information for the Gnash player. The target audience will be involved in developing Gnash technology, such as improvements to performance.

  1. Intro
    1. What is Gnash?
    2. What Does Gnash run on?
    3. Audience
    4. Organization of this manual
    5. Conventions Used in This Book
    6. Acknowledgements
  2. Installing Gnash
    1. Requirements - Software
      1. Linux
        1. Code Dependencies
        2. Documentation Dependencies
        3. Testing Dependencies
      2. (Windows) - future feature
      3. (OS X) - future feature
    2. Requirements - Hardware
    3. Downloading
      1. Using a Package Manager
      2. Downloading the Source Code
        1. GNU FTP mirror
        2. CVS Repository
      3. (Downloading the .exe File) - future feature
      4. (Downloading the .dmg File) - future feature
      5. Pre-Build Configuration
        1. General
        2. Features
        3. Specifying Custom Paths
        4. Cross Compiling
      6. Compiling Gnash
      7. Testing the Binary
      8. Installing Gnash
  3. Using Gnash
    1. General
    2. Command Line Options
    3. Interactive Control Keys
    4. User Configuration File
  4. Contribute to Gnash
    1. Reporting Bugs
      1. Compile the Latest Build
      2. Is This a New Bug?
      3. Review the Bug-Writing Guidelines
      4. File a Bug Report
  5. Glossary
  6. Index
  7. Authors
  8. GPL

MeToMe/MusicML Documentation

Outlines

Developer's Guide - This guide is meant to provide all of the technical details of MeToMe and MusicML to a highly technical audience. The target audience will be involved in maintaining an instance of MeToMe, or in publishing MusicML metadata, or will be an end-user seeking deeper understanding of MeToME/MusicML. This document will also provide detailed reference material, including vocabulary and syntax.

  1. Intro
  2. MusicML
    1. Intro
      1. Overview
      2. Best Practices
    2. Syntax
      1. One large example file that uses most available types of metadata. Analyze/discuss
    3. Vocabulary
    4. Catalogs
    5. Publishing
      1. Updating previously published metadata
      2. Batch publishing
  3. MeToMe
    1. Intro
      1. Overview
      2. Requirements (hardware, software)
      3. Best Practices
    2. Tables
    3. Indices
    4. Tools
    5. Performance
    6. Hosting
      1. Local/private instance
      2. Hosted/public instance

Publisher's Guide - This guide is meant for the average end user, who will be creating and publishing metadata to either a public or private instance of MeToMe. The audience will not be considered to be a strongly technical audience; complex topics will be referred to the Developer's Guide.

  1. Intro
    1. Why MusicML?
    2. Why MeToMe?
    3. History
    4. Licensing
  2. Writing Metadata Files
    1. Best Practices (Standards)
      1. One example file, filled in "chunk" with nearly every field. Dissect, analyze.
    2. How to create the file
      1. GUI (are we developing one?)
      2. Using a text editor
  3. Publishing
    1. Ingesting MusicML files to MeToME
      1. Locally
      2. To a remote instance
    2. Uploading MusicML to public instances
    3. Syncing pulic metadata to your local MeToMe
    4. Updating your published metadata
    5. Batch Publishing