MusicXML CLI Tool Specs

00-README.md

MusicXML CLI Tool Specs

• Self-Describing Page URL Alias: https://tinyurl.com/MusicXML-CLI-Tool-Specs

Project Abstract

• Open source musical scoring file templates shall drive max productivity for musical trainers and professionals.
• Open Source Tools That Generate MusicXML Scores From Templates = DocOpus ?
• Audiences + Demonstrations

Repository Structure + Files + Descriptions

• 00-README.md
• 01-audiences-and-demos.md
• 02-target-filespecs.md
• 03-first-example-cli-target.md

Table of Contents

• Statements of Purpose
• Audiences + Demonstrations
• Simplest Score Example
• Responsive Web Page Layouts
• Template Specifications

---

Statements of Purpose

• Composers, arrangers and musicians represent many wide ranges of musical scoring tool needs.

• The Future of Open Source Software = Web Apps + CLI Tools + YAML

  • This roadmap vastly extends and maximizes the value of stand-alone desktop apps.

• Open Source CLI tools and Web Apps are the Future, Guided by the MusicXML File Specification.

  • File Format Intercompatibility with other MusicXML generators and interpreters.

• Clean Slate Score Template Files are intelligent default starting points: 'Tabula Rasa Scores'

---

Simplest Score Examples

• A video tutorial about how to configure and generate 2+ such templates would be a great start.
• A video tutorial about how to create this same file manually would complete the set.
• Student Assignments Using Templates

---

Responsive Web Page Layouts

• Legacy Examples https://esvc006636.swp0002ssl.server-secure.com/articles/aut.htm

• Current Examples

• Emerging Examples

• Simple Score Template Targets

• Target Testing

This would simplify setups, training and workflows for the majority of MS4 users. This all falls under the category of "intelligent defaults".

Those file templates ought to be available in four file formats:

• MuseScore: mscz 4.x
• musicXML: mxl 3.x
• Printable Vector Output: pdf
• Image Output: png
• A fifth file format to consider might be MIDI.

Naming these files ought to be self-describing, for example:

• treble-clef-only-tabula-rasa-1-page.{mscz,mxl,pdf,png}
• bass-clef-only-tabula-rasa-1-page.{mscz,mxl,pdf,png}
• treble-and-bass-clefs-tabula-rasa-1-page.{mscz,mxl,pdf,png}

Including standard time-signature file template options would also be wise? Including placeholder headings and lyrics also makes some sense.

• Open Source MusicXML Workflows

• docOpt

• docOpus

• docProjs

• docLabs

01-audiences-and-demos.md

DocOpus: Audiences + Demos

DocOpus Audiences

• Tools To Secure + Defend Score Property Rights
• Using Git and Github for Code or Content Versioning and Attribution
• Convert PDFs into MusicXML.
• Responsive Web Page i18n Support
• File Targets - Template File Testing - Template Default Configs - Template Configs Options

02-target-filespecs.md

DocOpus: Target File Specs

03-first-example-cli-target.md

DocOpus: First Example CLI Target

04-proposed-subcommand-tree.md

DocOpus: Proposed Subcommand Tree

---

Conventional Command Flag:

• --version
• --help
• --debug
• --config

version

• flags: none

help

configure

debug

analyze

• Subcommand flag with implicit default: --input-file-type=musicxml
  • Subcommand flag options

parse

generate

• Default configs.
• Default target files.
• Default template tests.
• Default template files.

test

register

demo

docs

version