inputs and outputs requirements
| Requirement | Description |
|---|---|
| pdf output | the tool output will be pdf files |
| wav output | the tool will output wav files when needed |
| input | the input are text files |
export requirements
| Requirement | Description |
|---|---|
| delivery dir | all export files (pdf and wav) will be available in one dir |
| google drive | export to google drive |
dependencies requirements
| Requirement | Description |
|---|---|
| os | OS and required tools |
interface requirements : two user modes
| Requirement | Description |
|---|---|
| text editor | text editor mode |
| web mode | web browser mode |
dependencies requirements
| Requirement | Description |
|---|---|
| os | OS and required tools |
rendering requirements :
what to find in the pdf output
| Requirement | Description |
|---|---|
| sections | a song is structured as sections |
| refs | a section can be a reference to another one |
| musicsheet | insertion of music sheet snippet |
| tempo | show song tempo |
| time signature | show time signature |
| color | coloring of sections |
| bar numbering | show numbering of bars |
| time | show time on bars |
| book | definition of book |
| last modified time | the last modified time of a song will be rendered |
| lyrics | lyrics will be rendered, synced with the sections |
| coherence | tempo, signature and bar numbers will be coherent in the doc |
| table | the section chords will be rendered as tables |
| chord symbol | the chords in a table will be rendered in a standard way |
| chords per bar | render up to 2 chords per bar |
| line repeat | show line repeats to make rendering smaller |
| text rendering | text rendering will have a lot of features |
wav files
whenever a piece of music sheet is present in the song, it will be possible to generate a wav output for that piece.
input
all inputs are readable text files. It will therefore be possible to put them in a git repo and manage the life of these files
two edit modes
there will be two modes : the local and the web mode
output export
provided correct configuration, it will be possible to export the pdf outputs to a google drive
web mode
in web mode, you edit the remote files via a web interface, you trigger the generate of the pdf file by clicking a button on the web interface
Operating System
the software will run on standard ubuntu. There is no requirement that it runs on windows.
Delivery Directory
All output files will be available in one directory.
google drive
A command will allow to upload all pdf files to a google drive location, if correct credentials are provided