From 85ed4a8e026fccc339f8e85916184a1f8ec0bc69 Mon Sep 17 00:00:00 2001 From: Jonathan Moore Liles Date: Wed, 27 Jan 2010 03:00:29 -0600 Subject: [PATCH] Add documentation for mixer and restructure supporting tree. --- Makefile | 15 +- Timeline/TLE.fl | 4 +- doc/Makefile | 15 +- doc/OVERVIEW.html | 40 +- doc/OVERVIEW.mu | 154 +--- doc/{ => non-daw}/MANUAL.html | 0 doc/{ => non-daw}/MANUAL.mu | 0 doc/{ => non-daw}/annotations.png | Bin doc/{ => non-daw}/automation.png | Bin doc/{ => non-daw}/clocks.png | Bin doc/non-daw/crappy-screenshot.png | Bin 0 -> 106085 bytes doc/{ => non-daw}/fade-in-out.png | Bin doc/{ => non-daw}/looping.png | Bin doc/non-daw/mup.css | 449 +++++++++++ doc/{ => non-daw}/new-project.png | Bin doc/{ => non-daw}/project-info.png | Bin doc/{ => non-daw}/range.png | Bin doc/{ => non-daw}/recording.png | Bin doc/{ => non-daw}/tempomap.png | Bin doc/{ => non-daw}/tle.png | Bin doc/{ => non-daw}/track-header.png | Bin doc/{ => non-daw}/transport.png | Bin doc/non-mixer/MANUAL.html | 198 +++++ doc/non-mixer/MANUAL.mu | 159 ++++ doc/non-mixer/controls.png | Bin 0 -> 6528 bytes doc/non-mixer/gverb-parameters-hsliders.png | Bin 0 -> 7953 bytes doc/non-mixer/gverb-parameters-knobs.png | Bin 0 -> 7062 bytes doc/non-mixer/gverb-parameters-vsliders.png | Bin 0 -> 8070 bytes doc/non-mixer/mixer-strips.png | Bin 0 -> 26678 bytes doc/non-mixer/modules.png | Bin 0 -> 5046 bytes doc/non-mixer/mup.css | 449 +++++++++++ doc/non-mixer/new-project.png | Bin 0 -> 6967 bytes .../non-mixer-and-non-daw-in-patchage.png | Bin 0 -> 49841 bytes doc/non-mixer/non-mixer-complex.png | Bin 0 -> 126774 bytes doc/non-mixer/single-strip.png | Bin 0 -> 6208 bytes pixmaps/logo.png | Bin 33460 -> 0 bytes pixmaps/non-daw/logo.png | Bin 0 -> 21267 bytes pixmaps/{ => non-daw}/logo.svg | 0 pixmaps/{ => non-daw}/logo2.png | Bin pixmaps/{ => non-daw}/logo2.svg | 0 pixmaps/non-mixer/logo.png | Bin 0 -> 30534 bytes pixmaps/non-mixer/logo.svg | 712 ++++++++++++++++++ 42 files changed, 2065 insertions(+), 130 deletions(-) rename doc/{ => non-daw}/MANUAL.html (100%) rename doc/{ => non-daw}/MANUAL.mu (100%) rename doc/{ => non-daw}/annotations.png (100%) rename doc/{ => non-daw}/automation.png (100%) rename doc/{ => non-daw}/clocks.png (100%) create mode 100644 doc/non-daw/crappy-screenshot.png rename doc/{ => non-daw}/fade-in-out.png (100%) rename doc/{ => non-daw}/looping.png (100%) create mode 100644 doc/non-daw/mup.css rename doc/{ => non-daw}/new-project.png (100%) rename doc/{ => non-daw}/project-info.png (100%) rename doc/{ => non-daw}/range.png (100%) rename doc/{ => non-daw}/recording.png (100%) rename doc/{ => non-daw}/tempomap.png (100%) rename doc/{ => non-daw}/tle.png (100%) rename doc/{ => non-daw}/track-header.png (100%) rename doc/{ => non-daw}/transport.png (100%) create mode 100644 doc/non-mixer/MANUAL.html create mode 100644 doc/non-mixer/MANUAL.mu create mode 100644 doc/non-mixer/controls.png create mode 100644 doc/non-mixer/gverb-parameters-hsliders.png create mode 100644 doc/non-mixer/gverb-parameters-knobs.png create mode 100644 doc/non-mixer/gverb-parameters-vsliders.png create mode 100644 doc/non-mixer/mixer-strips.png create mode 100644 doc/non-mixer/modules.png create mode 100644 doc/non-mixer/mup.css create mode 100644 doc/non-mixer/new-project.png create mode 100644 doc/non-mixer/non-mixer-and-non-daw-in-patchage.png create mode 100644 doc/non-mixer/non-mixer-complex.png create mode 100644 doc/non-mixer/single-strip.png delete mode 100644 pixmaps/logo.png create mode 100644 pixmaps/non-daw/logo.png rename pixmaps/{ => non-daw}/logo.svg (100%) rename pixmaps/{ => non-daw}/logo2.png (100%) rename pixmaps/{ => non-daw}/logo2.svg (100%) create mode 100644 pixmaps/non-mixer/logo.png create mode 100644 pixmaps/non-mixer/logo.svg diff --git a/Makefile b/Makefile index 119872b..7f373cb 100644 --- a/Makefile +++ b/Makefile @@ -35,9 +35,9 @@ config: -include .config -export SYSTEM_PATH:=$(prefix)/share/non-daw/ -export DOCUMENT_PATH:=$(prefix)/share/doc/non-daw/ -export PIXMAP_PATH:=$(prefix)/share/pixmaps/non-daw/ +export SYSTEM_PATH:=$(prefix)/share/ +export DOCUMENT_PATH:=$(prefix)/share/doc/ +export PIXMAP_PATH:=$(prefix)/share/pixmaps/ # a bit of a hack to make sure this runs before any rules ifneq ($(CALCULATING),yes) @@ -119,9 +119,12 @@ install: all @ echo -n "Installing..." @ install Timeline/timeline $(prefix)/bin/non-daw @ install Mixer/mixer $(prefix)/bin/non-mixer - @ mkdir -p $(SYSTEM_PATH) - @ mkdir -p $(PIXMAP_PATH) - @ cp pixmaps/*.png $(PIXMAP_PATH) + @ mkdir -p $(SYSTEM_PATH)/non-daw + @ mkdir -p $(PIXMAP_PATH)/non-daw + @ mkdir -p $(SYSTEM_PATH)/non-mixer + @ mkdir -p $(PIXMAP_PATH)/non-mixer + @ cp pixmaps/non-mixer/*.png $(PIXMAP_PATH)/non-mixer + @ cp pixmaps/non-daw/*.png $(PIXMAP_PATH)non-daw @ $(MAKE) -s -C doc install @ echo "$(DONE)" ifneq ($(USE_DEBUG),yes) diff --git a/Timeline/TLE.fl b/Timeline/TLE.fl index 213e871..c98d114 100644 --- a/Timeline/TLE.fl +++ b/Timeline/TLE.fl @@ -890,7 +890,7 @@ Fl::check();} {} } { code {char pat[256]; -snprintf( pat, 256, "file://%s%s.html", DOCUMENT_PATH, file ); +snprintf( pat, 256, "file://%s/non-daw/%s.html", DOCUMENT_PATH, file ); open_url( pat );} {} } @@ -966,7 +966,7 @@ if ( logo_box->image() ) Fl_Box logo_box { label {} private xywh {51 180 418 235} box ROUNDED_BOX color 53 labelfont 1 labelsize 18 align 16 - code0 {o->image( Fl_Shared_Image::get( INSTALL_PREFIX "/share/pixmaps/non-daw/logo2.png" ) );} + code0 {o->image( Fl_Shared_Image::get( PIXMAP_PATH "non-daw/logo2.png" ) );} code1 {o->label( NULL );} } Fl_Text_Editor notes_field { diff --git a/doc/Makefile b/doc/Makefile index cddf39c..ba9e707 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -1,6 +1,11 @@ +NM_SRCS=$(wildcard non-mixer/*.mu) SRCS=$(wildcard *.mu) +ND_SRCS=$(wildcard non-daw/*.mu) + OBJS=$(SRCS:.mu=.html) +NM_OBJS=$(NM_SRCS:.mu=.html) +ND_OBJS=$(ND_SRCS:.mu=.html) %.html: %.mu @ echo Mupping $<... @@ -16,9 +21,11 @@ upload: all @ rm -f index.html install: - @ mkdir -p $(DOCUMENT_PATH) - @ cp $(OBJS) *.png mup.css ../COPYING $(DOCUMENT_PATH) - @ ln -sf $(PIXMAP_PATH)/logo.png $(DOCUMENT_PATH) + @ mkdir -p $(DOCUMENT_PATH)/non-daw + @ mkdir -p $(DOCUMENT_PATH)/non-mixer + @ cp $(ND_OBJS) non-daw/*.png non-daw/mup.css ../COPYING $(DOCUMENT_PATH)/non-daw + @ cp $(NM_OBJS) non-mixer/*.png non-mixer/mup.css ../COPYING $(DOCUMENT_PATH)/non-mixer +# @ ln -sf $(PIXMAP_PATH)/logo.png $(DOCUMENT_PATH) clean: - rm -f $(OBJS) + rm -f $(OBJS) $(NM_OBJS) $(ND_OBJS) diff --git a/doc/OVERVIEW.html b/doc/OVERVIEW.html index 9487191..860d1c7 100644 --- a/doc/OVERVIEW.html +++ b/doc/OVERVIEW.html @@ -47,6 +47,8 @@ March 1, 2008
  • What does freedom have to do with this software?
  • Donations @@ -64,7 +66,7 @@ March 1, 2008
    The Non DAW is a powerful, reliable and fast modular Digital Audio Workstation system, released under the GNU General Public License (GPL). It utilizes the JACK Audio Connection Kit for inter-application audio I/O and the FLTK GUI toolkit for a fast and lightweight user interface.

    -Please see the manual for more information. +Please see the Non DAW Manual and Non Mixer Manual for more information.

    1.2. What it is not

    @@ -80,7 +82,7 @@ In this author's opinion, a DAW comprises the following functionality:

    • Non-linear, non-destructive arrangement of portions of audio clips.
    • Tempo and time signature mapping, with editing operations being closely aligned to this map.

    -Since Non uses JACK for IO, some things traditionally considered to be within the scope of a monolithic DAW can be pared out: +Since Non uses JACK for IO, some things traditionally considered to be within the scope of a monolithic DAW can be pared out into JACK and Non Mixer: