Merge branch 'dev' of gitlab.cristal.univ-lille.fr:boeuf/bf-pd into dev

LICENSE

+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/>
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    bf-pd
+    Copyright (C) 2019  BOEUF
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  {signature of Ty Coon}, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

README.md

-# bf-pd 
+# bf-pd : a PureData external for building Digital Orchestras
 
-## Description 
+## Introduction: What is bf-pd and why do you need it?
 
-bf-pd is an implementation for PureData of the BOEUF framework, which enables advanced collaboration modes in spontaneous digital orchestras.
+Digital instruments allow us to do things that were not possible with purely acoustic instruments. For example musicians can share data between instruments in real-time, in effect creating distributed multi-musician super-instruments. Musicians such as The Hub have been doing this since at least the 1970s. Contemporary digital musicians often write their own software instruments to re-create these functionalities.
 
-Help and tutorials can be found in the [documentation folder.](doc/README.md)
+Bf-pd is a library built in PureData (Pd) which enables communication and cooperation between digital instruments. Bf-pd can be integrated into any instrument built in Pd. It provides a *collaboration window* from which musicians can view each others’ activity and share control of instrument parameters and other musical data.
 
-## Requires the following puredata libraries (Help->Find Externals)
+The design of bf-pd is based on the BOEUF conceptual framework which consists of a classification of modes of collaboration used in collective music performance, and a set of components which affords them. More details on the BOEUF conceptual framework can be found
+[on this page](doc/boeuf.md).
 
-* mrpeach
+## Installing bf-pd
+
+- Download and install Pure Data (>=0.51) for your operating system from https://puredata.info/downloads/pure-data
+- Install the **mrpeach** library using Deken (PD -> Help -> Find Externals)
+- Install **bf-pd** using Deken
+
+## Getting started: Building your instrument
+
+![doc/img/start.gif](doc/img/start.gif)
+
+Starting from an existing instrument made in PureData :
+
+1. Create a declare object with -path bf-pd
+2. Create a bf-instrument object with your instrument name as argument
+3. Connect the sound output of your instrument to its inlet
+4. Create a bf-param object for each control you want to share with the others and insert it into your instrument
+5. Create a bf-session object with the name of the session you want to connect to
+
+### Parameters and outputs
+
+**Parameters** correspond to controls you have over your instrument and that you want to share with others.
+
+![doc/img/bf-param.gif](doc/img/bf-param.gif)
+
+
+**Outputs** have the same properties but correspond to musical content produced by your instruments (notes, onsets, envelopes ...). They can be used to control others parameters.
+Three default outputs are automatically created by bf-pd and extracted from the audio you send to bf-instrument : pitch, onsets, loudness.
+
+![doc/img/bf-output.gif](doc/img/bf-output.gif)
+
+
+Parameters and outputs have the same **arguments** :
+
+1. instrument name
+2. parameter / output namenumberOfValues valuesType parameterIndex ]
+3. number of values
+4. type of values : cont (0 to 1), midi (0 to 127), bool (0 or 1), bang
+5. index : position in the collaboration window
+
+## Performance: Making music together using bf-pd
+
+### The collaboration window
+
+The collaboration window is a collaboration interface that comes with bf-pd and provides a way to connect your instrument with other instruments in the session.
+
+To open the collaboration window, simply check the *collab* toggle in the bf-instrument object.
+
+The leftmost green column shows your instrument with its outputs and parameters. The grey columns show the other instruments in the session with their respective activity, outputs and parameters.
+
+![doc/img/collabwin.png](doc/img/collabwin.png)
+
+### Sharing / granting access to your parameters
+
+By default, all your parameters are in the *granted* mode, which means that all the other musicians can change your parameter values. You can of course change this by clicking the red *grant* toggle for each parameter, or the *grant all* toggle at the top of your column.
+When your parameter is not granted, values *asked* by others are only displayed on the gray widgets. You can accept their *ask* by using the *1x* bang.
+
+![doc/img/sharing.gif](doc/img/sharing.gif)
+
+### Using others parameters and outputs to change your parameters
+
+A *watch* bus selector is placed below each parameter and output of the other instruments. By choosing a bus other than 0, the values are sent to the corresponding bus and can be sent to your parameters connected to the same bus using the *watching* selector.
+
+![doc/img/watching.gif](doc/img/watching.gif)
+
+### Controlling others parameters with your parameters and outputs
+
+Symmetrically, you can control others parameters by choosing a non-zero bus on the *ask* selector and the same *asking* bus below one of your outputs or parameters. This requires however that the parameter that you want to controlled is *granted* (i.e. that the green *granted* toggle is checked).
+
+![doc/img/asking.gif](doc/img/asking.gif)
+
+
+### Directly asking / controlling others parameters
+
+You can also ask another instrument's parameter to be set to a specific value by interacting with the white sliders/toggles/bangs. It the access is granted, the value will be directly set.
+
+![doc/img/direct_asking.gif](doc/img/direct_asking.gif)
+
+## Demo Video 
+
+<a href="https://pod.univ-lille.fr/video/19614-bf-pd-collaboration-window/"><img src="doc/img/video.png" height="300px"/><br/>Video demoing the collab window for bf-pd</a>.
+
+## More resources
+
+Documentation for each of the user objects in bf-pd can be found in [objects.md](doc/objects.md) and on help patches directly in PureData (right-click an object -> Help)
+
+The *BOEUF conceptual framework* describes the *modes of collaboration* used in musical collaboration and describes a set of *components* for realizing these modes in a software framework. Bf-pd is based on this framework. More info can be found in [boeuf.md](doc/boeuf.md).
 
 ## Authors 
 
 * Luke Dahl, University of Virginia
 * Florent Berthaut, University of Lille
 
-
-

doc/README.md

+# bf-pd documentation 
 
-# Introduction: What is bf-pd and why do you need it?
-
-Digital instruments allow us to do things that were not possible with purely acoustic instruments. For example musicians can share data between instruments in real-time, in effect creating distributed multi-musician super-instruments. Musicians such as The Hub have been doing this since at least the 1970s. Contemporary digital musicians often write their own software instruments to re-create these functionalities.
-
-Bf-pd is a library built in PureData (Pd) which enables communication and cooperation between digital instruments. Bf-pd can be integrated into any instrument built in Pd. It provides a *collaboration window* from which musicians can view each others’ activity and share control of instrument parameters and other musical data.
-
-The design of bf-pd is based on the BOEUF conceptual framework which consists of a classification of modes of collaboration used in collective music performance, and a set of components which affords them. More details on the BOEUF conceptual framework can be found
-[on this wiki page](boeuf.md).
-
-# Installing bf-pd
-
-- Download and install Pure Data for your operating system from https://puredata.info/downloads/pure-data
-- Install the **mrpeach** library using Deken (PD -> Help -> Find Externals)
-- Install **bf-pd** using Deken
-
-# Getting started: Building your instrument
-
-![img/start.gif](img/start.gif)
-
-- Create a declare object with -path bf-pd
-- Create a bf-instrument object with your instrument name as argument
-- Connect the sound output of your instrument to its inlet
-- Create a bf-param object for each control you want to share with the others and insert it into your instrument
-- Create a bf-session object with the name of the session you want to connect to
-
-# Performance: Making music together using bf-pd
-### The collaboration window
-
-### Sharing parameters
-
-### Connecting parameters using ask and watch
-
-
-### Video example 
-
-<a href="https://vimeo.com/214380530">Video showing a simple session</a>
-
-
-# More resources
-
-Documentation for each of the user objects in bf-pd can be found in [objects.md](objects.md).
-
-The *BOEUF conceptual framework* describes the *modes of collaboration* used in musical collaboration and describes a set of *components* for realizing these modes in a software framework. Bf-pd is based on this framework. More info can be found in [boeuf.md](boeuf.md).
 
+* Explanations on the BOEUF framework for collaboration modes in orchestras [on this page](boeuf.md).
+* List of bf-pd [objects](objects.md)

doc/boeuf.html

+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
+<head>
+  <meta charset="utf-8" />
+  <meta name="generator" content="pandoc" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
+  <title>bf-pd : the BOEUF framework</title>
+  <style>
+    code{white-space: pre-wrap;}
+    span.smallcaps{font-variant: small-caps;}
+    span.underline{text-decoration: underline;}
+    div.column{display: inline-block; vertical-align: top; width: 50%;}
+    div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
+    ul.task-list{list-style: none;}
+  </style>
+  <link rel="stylesheet" href="img/style.css" />
+</head>
+<body>
+<nav>
+	<li><a href="index.html">Home</a></li>
+	<li><a href="boeuf.html">BOEUF</a></li>
+	<li><a href="objects.html">Objects</a></li>
+</nav>
+<main>
+<h1 id="the-boeuf-conceptual-framework">The BOEUF conceptual framework</h1>
+<p>BOEUF is a conceptual framework for modeling and building orchestras of digital musical instruments. It consists of a classification of <em>modes of collaboration</em>, and a set of <em>components</em> which can be used to enable these modes in digital instruments. We developed this classification after conducting interviews with digital musicians who work in ensembles, as well as literature review of work on digital ensembles and collaborative instruments. The word “boeuf” is french slang for a jam session.</p>
+<h2 id="modes-of-collaboration">Modes of Collaboration</h2>
+<p>The <em>modes of collaboration</em> are a categorization which is intended to describe all the ways that musicians collaborate and communicate during performance. This includes interactions which are <em>mediated</em> (i.e. take place through some technology) as well as <em>unmediated</em> interactions (which can occur through being in the same space together.)</p>
+<p>We propose that there are three modes of collaboration: <em>Cooperation</em>, <em>Communication</em>, and <em>Organisation</em></p>
+<h3 id="cooperation-modes">Cooperation Modes</h3>
+<p><em>Cooperation</em> describes the ways that musicians coordinate their actions with respect to their instruments. This cooperation can be:</p>
+<ul>
+<li><p><strong>Independent:</strong> Each musician controls their own instrument. For example, when two musicians begin to play their instruments at the same time this is <em>independent cooperation</em>. They are cooperating because they coordinated their musical gestures, but they act only on their own instrument.</p></li>
+<li><p><strong>Complementary:</strong> Multiple musicians can affect different aspects of the same musical process. For example, when one musician adds effects to a sound generated by another musician.</p></li>
+<li><p><strong>Concurrent:</strong> Multiple musicians can control the same aspect of the same musical musical process. For example, when two musicians can both control some parameter (e.g. filter cutoff frequency) on the same instrument.</p></li>
+</ul>
+<h3 id="communication-modes">Communication Modes</h3>
+<p><em>Communication</em> describes how musicians exchange information which may then influence their actions.</p>
+<ul>
+<li><p><strong>Awareness:</strong> Awareness describes all non-intentional communication. For example being able to see the movements of other musicians.</p></li>
+<li><p><strong>Indication:</strong> Indications are intentional communicative acts. For example, cueing an entrance. Deliberate nods and glances between musicians may be indications.</p></li>
+<li><p><strong>Exchanges:</strong> Exchange is the transfer of musical data between musicians. For example, in a digital ensemble on musician might send a sequence of notes to another’s instrument. Or in a jazz ensemble a soloist might use a motif from the previous soloist.</p></li>
+</ul>
+<h3 id="organisation-modes">Organisation Modes</h3>
+<p><em>Organisation</em> describes the relationships between musicians. Organisation does not directly affect the sound production, but it impacts how the communication and cooperation modes operate.</p>
+<ul>
+<li><p><strong>Nomination: </strong> Nomination is that act of defining the roles of musicians within the group. For example one musician might be the conductor, another might be a soloist.</p></li>
+<li><p><strong>Grouping</strong> The act of grouping defines a hierarchy of groups of instruments. For example a musician might be in the group “viola players” as well as in the group “string section.”</p></li>
+<li><p><strong>Selection</strong> Selection is the act of choosing a group or instrument for cooperation or communication. For example, a conductor might gesture to the wind section (thereby selecting them) before cueing their entrance (indication.)</p></li>
+</ul>
+<h2 id="the-boeuf-components">The Boeuf components</h2>
+<p>[TODO]</p>
+<h2 id="navigate">Navigate</h2>
+<ul>
+<li>The BOEUF project: <a href="https://bf-collab.net/bf/"></a></li>
+<li>The Bf-Pd library: <a href="https://gitlab.cristal.univ-lille.fr/boeuf/bf-pd/blob/master/README.html"></a></li>
+</ul>
+</main>
+</body>
+</html>

doc/boeuf.md

@@ -38,3 +38,7 @@ We propose that there are three modes of collaboration: *Cooperation*, *Communic
 
 ## The Boeuf components
 [TODO]
+
+## Navigate
+* The BOEUF project: [](https://bf-collab.net/bf/)
+* The Bf-Pd library: [](https://gitlab.cristal.univ-lille.fr/boeuf/bf-pd/blob/master/README.md)
\ No newline at end of file

doc/build.sh

+pandoc ../README.md -o index.html -s --lua-filter=img/md_to_html.lua -c img/style.css --template=img/template.html --metadata title="bf-pd : index"
+pandoc boeuf.md -o boeuf.html -s --lua-filter=img/md_to_html.lua -c img/style.css --template=img/template.html --metadata title="bf-pd : the BOEUF framework"
+pandoc objects.md -o objects.html -s --lua-filter=img/md_to_html.lua -c img/style.css --template=img/template.html --metadata title="bf-pd : objects"

doc/img/md_to_html.lua

+function Link(el)
+	el.target = string.gsub(el.target, "%.md", ".html")
+	el.target = string.gsub(el.target, "doc/", "")
+	return el
+end
+
+function Image(el)
+	el.src = string.gsub(el.src, "doc/", "")
+	return el
+end
+
+function RawInline (raw)
+	if raw.format == 'html' then 
+		return pandoc.RawInline('html', string.gsub(raw.text, "doc/img", "img"))
+	end
+end
+

doc/img/style.css

+body {
+	display:grid;
+	grid:"nav main" auto
+		/ 100px 1fr;
+	grid-gap:10px;
+	padding:0px 5% 50px 5%;
+	font-family:sans-serif;
+}
+
+main {
+	grid-area:main;
+	background-color:#DDD;
+	padding:0px 5px;
+}
+
+nav {
+	grid-area:nav;
+	font-size:1.2em;
+	position:sticky;
+	top:5px;
+	background-color:#333;
+	align-self:start;
+}
+
+nav li {
+	 list-style-type:none;
+	 width:100%;
+}
+
+nav a {
+	color:white;
+	background-color:#333;
+	width:100%;
+	font-weight:bold;
+}
+
+nav a:hover {
+	color:#333;
+	background-color:white;
+}
+
+a {
+	color:#333;
+}
+
+a:hover {
+	color:white;
+	background-color:#333;
+}
+
+h1 {
+	margin-top:0px;
+}
+
+h1, h2 {
+	color:white;
+	background-color: #333;
+}
+
+img {
+	max-width:100%;
+	border:2px black solid;
+}
+
+figcaption {
+	display:none;
+}
+

doc/img/template.html

+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" lang="$lang$" xml:lang="$lang$"$if(dir)$ dir="$dir$"$endif$>
+<head>
+  <meta charset="utf-8" />
+  <meta name="generator" content="pandoc" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
+$for(author-meta)$
+  <meta name="author" content="$author-meta$" />
+$endfor$
+$if(date-meta)$
+  <meta name="dcterms.date" content="$date-meta$" />
+$endif$
+$if(keywords)$
+  <meta name="keywords" content="$for(keywords)$$keywords$$sep$, $endfor$" />
+$endif$
+  <title>$if(title-prefix)$$title-prefix$ – $endif$$pagetitle$</title>
+  <style>
+    $styles.html()$
+  </style>
+$for(css)$
+  <link rel="stylesheet" href="$css$" />
+$endfor$
+$if(math)$
+  $math$
+$endif$
+$for(header-includes)$
+  $header-includes$
+$endfor$
+</head>
+<body>
+$for(include-before)$
+$include-before$
+$endfor$
+<nav>
+	<li><a href="index.html">Home</a></li>
+	<li><a href="boeuf.html">BOEUF</a></li>
+	<li><a href="objects.html">Objects</a></li>
+</nav>
+<main>
+$body$
+</main>
+$for(include-after)$
+$include-after$
+$endfor$
+</body>
+</html>