From 995a0d6edb1920a18ef7db8c44630d6b8511ed5a Mon Sep 17 00:00:00 2001 From: Alexandre Quessy Date: Wed, 28 Dec 2016 14:24:45 -0500 Subject: [PATCH] Fix #274: Document OSC within the software --- AboutDialog.cpp | 14 +++++++++ AboutDialog.h | 1 + HACKING | 2 ++ docs/documentation.qrc | 1 + docs/informations/osc.html | 60 ++++++++++++++++++++++++++++++++++++++ docs/informations/osc.md | 45 ++++++++++++++++++++++++++++ scripts/update-osc.sh | 4 +++ 7 files changed, 127 insertions(+) create mode 100644 docs/informations/osc.html create mode 100644 docs/informations/osc.md create mode 100755 scripts/update-osc.sh diff --git a/AboutDialog.cpp b/AboutDialog.cpp index b20e4bc..7ba439e 100644 --- a/AboutDialog.cpp +++ b/AboutDialog.cpp @@ -69,6 +69,8 @@ AboutDialog::AboutDialog(QWidget *parent) : QDialog(parent) createContributorsTab(); // License createLicenseTab(); + + createOscTab(); } void AboutDialog::createAboutTab() @@ -160,4 +162,16 @@ void AboutDialog::createLicenseTab() _tabWidget->addTab(_licenseTextBrowser, tr("License")); } +void AboutDialog::createOscTab() +{ + + QTextBrowser * + oscBrowser = new QTextBrowser; + oscBrowser->setOpenExternalLinks(true); + QFile oscFile(":/osc_html"); + oscFile.open(QIODevice::ReadOnly | QIODevice::Text); + oscBrowser->setText(QTextCodec::codecForName("UTF-8")->toUnicode(oscFile.readAll())); + _tabWidget->addTab(oscBrowser, tr("OSC")); +} + } diff --git a/AboutDialog.h b/AboutDialog.h index 2666d91..0b80d03 100644 --- a/AboutDialog.h +++ b/AboutDialog.h @@ -46,6 +46,7 @@ private: void createLibrariesTab(); void createContributorsTab(); void createLicenseTab(); + void createOscTab(); QGridLayout *_mainLayout; QLabel *_iconLabel; diff --git a/HACKING b/HACKING index 0544d4d..4fe9993 100644 --- a/HACKING +++ b/HACKING @@ -37,6 +37,7 @@ Files * TODO: You can put things to do there, or use https://github.com/mapmapteam/mapmap, or https://www.pivotaltracker.com/s/projects/954570/ * images/: Images part of the GUI. * prototypes/ : Contains prototypes. Please ask the project maintainer before removing some of these. +* docs/informations/*.md Markdown files to generate the About dialog Code management with Git ------------------------ @@ -59,6 +60,7 @@ Make a release * PROJECT_NUMBER in Doxyfile * Edit NEWS - update with the news for the release you are about to make * Run ./scripts/update-changelog.sh and commit the changes +* Maybe update the docs/informations/osc.md file and run scripts/update-osc.sh and commit the changes * Maybe update the docs/informations/CONTRIBUTORS.md file and run scripts/update-contributors.sh and commit the changes * run make * run ./sh_build_doc.sh diff --git a/docs/documentation.qrc b/docs/documentation.qrc index f7180f3..1056bc3 100644 --- a/docs/documentation.qrc +++ b/docs/documentation.qrc @@ -5,5 +5,6 @@ informations/LICENSE_SHORT.txt informations/MAPPING informations/CONTRIBUTORS.html + informations/osc.html diff --git a/docs/informations/osc.html b/docs/informations/osc.html new file mode 100644 index 0000000..5eb12ac --- /dev/null +++ b/docs/informations/osc.html @@ -0,0 +1,60 @@ +

Currently supported commands

+ +

Paints

+ +

Paint ids are numbered from 1 to N.

+ + + +

Color paint

+ + + +

Image/Video paint

+ + + +

Mappings

+ +

Mappings are numbered from 1 to N.

+ + + +

Regular expressions

+ +

Alternatively to ids, one can use a string pattern describing a regexp over the paint or mapping names. The regular expression follows a simple "file globbing" / wildcard syntax. It is case-sensitive.

+ +

Examples:

+ + + +

Playback

+ + diff --git a/docs/informations/osc.md b/docs/informations/osc.md new file mode 100644 index 0000000..fdbe2f5 --- /dev/null +++ b/docs/informations/osc.md @@ -0,0 +1,45 @@ +# Currently supported commands + +## Paints +Paint ids are numbered from 1 to N. + +- /mapmap/paint/name ,is Change name of paint. +- /mapmap/paint/opacity ,if Change opacity of paint. Range: [0,1] + +### Color paint + +- /mapmap/paint/color ,is Change color of paint. (eg. "#ff0000") + +### Image/Video paint + +- /mapmap/paint/rate ,if Change rate (speed) of paint Range: [0,1] +- /mapmap/paint/uri ,is Change URI of paint. (eg. file:///home/example/example.mov) +- /mapmap/paint/volume ,if Change audio volume of paint. Range: [0,1] +- /mapmap/paint/rewind ,i Rewind paint + +## Mappings +Mappings are numbered from 1 to N. + +- /mapmap/mapping/depth ,ii Change depth of mapping. (layer order) +- /mapmap/mapping/locked ,ii Change lock status of mapping (0 or 1) +- /mapmap/mapping/name ,is Change name of mapping +- /mapmap/mapping/opacity ,if Change opacity of mapping. Range: [0,1] +- /mapmap/mapping/solo ,ii Change solo status of mapping (0 or 1) +- /mapmap/mapping/visible ,ii Change visibility status of mapping (0 or 1) + +## Regular expressions +Alternatively to ids, one can use a string pattern describing a regexp over the paint or mapping names. The regular expression follows a [simple "file globbing" / wildcard syntax](http://doc.qt.io/qt-5/qregexp.html#wildcard-matching). It is case-sensitive. + +Examples: + +- /mapmap/paint/opacity ,sf movie.mov 0.1 Change opacity of paint named "movie.mov" to 0.1 (10%) +- /mapmap/paint/opacity ,sf "movie_*" 0.5 Change opacity of all paints whose name begins by "movie_" to 0.5 (50%) +- /mapmap/paint/rewind ,s "*.mov" Rewind all .mov paints +- /mapmap/mapping/solo ,s "mesh_[0-9]" 1 Sets all mappings that begin with "mesh_" followed by a single digit to solo mode + +## Playback + +- /mapmap/pause Stop playback +- /mapmap/play Start playback +- /mapmap/quit Quit MapMap +- /mapmap/rewind Rewind/reset diff --git a/scripts/update-osc.sh b/scripts/update-osc.sh new file mode 100755 index 0000000..506c8d5 --- /dev/null +++ b/scripts/update-osc.sh @@ -0,0 +1,4 @@ +#!/bin/sh +set -o verbose +# Convert markdown file to html +markdown docs/informations/osc.md > docs/informations/osc.html