Recent changes to Introduction

WikiPage Introduction modified by SunnyFish

SunnyFish — Mon, 13 Aug 2012 16:12:56 -0000

--- v11
+++ v12
@@ -2,10 +2,11 @@
 ===============
 Author: Zeyu Jin (Carnegie Mellon University) 
 
-### Contents
+Contents
 
-1. [LSD API Usage]
-2. [Hcmp Communication Spec]
+1. [Introduction]
+2. [LSD API Usage]
+3. [Hcmp Communication Spec]
 
 ### Introduction

WikiPage Home modified by SunnyFish

SunnyFish — Mon, 13 Aug 2012 16:12:10 -0000

--- v10
+++ v11
@@ -1,6 +1,13 @@
 Live Score Display
 ===============
 Author: Zeyu Jin (Carnegie Mellon University) 
+
+### Contents
+
+1. [LSD API Usage]
+2. [Hcmp Communication Spec]
+
+### Introduction
 
 Live Score Display (LSD for short) is an API for displaying musical score in live performance. This project is a part of Human-computer music performance which is intended to make virtual players (computers) cooperate with human in real music performance senario. The score display is such a virtual player who shows the proper part of score to human as music goes on.

WikiPage Home modified by SunnyFish

SunnyFish — Fri, 10 Aug 2012 13:53:44 -0000

--- v9
+++ v10
@@ -8,7 +8,7 @@
 
 To play with LSD, one needed to notated the score image manually (sorry, no automatic score recognition tool, maybe later); this process is to tell the program where the system, measures and symbols are on the score. Then the program will convert the user's notation automatically to flattened score model. If needed the user can re-arranged the score based on labels (like A, A1, B, etc). Then the program can generate dynamic score model and the live display window that plays with HCMP conductor. 
 
-This API package is not just specialized for HCMP. You can wire it into your own application and control it yourself.
+This API package is not just specialized for HCMP. You can wire it into your own application and control it yourself. To play it with HCMP conductor, follow the [HCMP messaging protocol].
 
 For more detailed API usage, go to [LSD API Usage]. To get started quickly, please read on.

WikiPage Home modified by SunnyFish

SunnyFish — Wed, 08 Aug 2012 16:31:22 -0000

--- v8
+++ v9
@@ -40,13 +40,17 @@
 ---------
 Example for opening a Live View window:
 
-:::java
-# LDController controller = new LDController("/somefolder/myworkspace");
-# String[] folders = controller.getDirList();
-# if (folders.length < 1) return;
-# controller.setDir(0);
-# controller.parse();
-# controller.openDialogLive(null, controller.getScoreFlat());
+    :::java
+    LDController controller = new LDController("/somefolder/myworkspace");
+    String[] folders = controller.getDirList();
+    if (folders.length < 1) return;
+    controller.setDir(0);
+    if (controller.parse()) {
+        controller.openDialogLive(null, controller.getScoreFlat());
+    } else {
+        System.out.println(controller.getErrorList());
+    }
+    
 
 it looks like:

WikiPage Home modified by SunnyFish

SunnyFish — Wed, 08 Aug 2012 16:29:45 -0000

--- v7
+++ v8
@@ -48,6 +48,10 @@
 # controller.parse();
 # controller.openDialogLive(null, controller.getScoreFlat());
 
+it looks like:
+
+[[img src=https://sourceforge.net/p/livedisp/wiki/Home/attachment/Screen%20Shot%202012-08-08%20at%2012.27.03%20PM.png]]
+
 That is done.
 
 FYI, this wiki uses [Markdown](/p/livedisp/wiki/markdown_syntax/) syntax.

WikiPage Home modified by SunnyFish

SunnyFish — Wed, 08 Aug 2012 16:20:45 -0000

--- v6
+++ v7
@@ -30,12 +30,26 @@
     * **getScoreSymbols()**: return the model of the original notations
     * **boolean parse()**: parse notation to flattened score. If false returned, the notation may contain unsolved errors. In this case, use getErrorList() to see the error.
     * **boolean getScoreStatic()**: return static score model. Use if after parse().
-    * **boolean getScoreFlattened()**:  return flattened score model. Use if after parse().
+    * **boolean getScoreFlat()**:  return flattened score model. Use if after parse().
     * **boolean getArragement()**: build the arrangement model of the current flattened score model. 
     * **boolean getScoreDynamic()**: build dynamic score based on the flattened score and the user's arrangement. 
 
 If you want to know other functions of this API (which may not be as useful as the above), see [LSD API Usage]. 
 
+Example
+---------
+Example for opening a Live View window:
+
+:::java
+# LDController controller = new LDController("/somefolder/myworkspace");
+# String[] folders = controller.getDirList();
+# if (folders.length < 1) return;
+# controller.setDir(0);
+# controller.parse();
+# controller.openDialogLive(null, controller.getScoreFlat());
+
+That is done.
+
 FYI, this wiki uses [Markdown](/p/livedisp/wiki/markdown_syntax/) syntax.
 
 [[project_admins]]

WikiPage Home modified by SunnyFish

SunnyFish — Wed, 08 Aug 2012 16:17:20 -0000

--- v5
+++ v6
@@ -18,21 +18,21 @@
 **The standard way**: use LDController:
 
 1. set workplace
-    * use setWorkplace(String dir) to set your workspace
-    * retrieve names of folders that contains score images by getDirList()
-    * set working folder by setDir(int index), the index is indicated by returned list of getDirList()
+    * use **setWorkplace(String dir)** to set your workspace
+    * retrieve names of folders that contains score images by **getDirList()**
+    * set working folder by **setDir(int index)**, the index is indicated by returned list of getDirList()
 + get GUI component
-    * for notation, use getNotationPanel()
-    * for toolbars related with notation, use getToolbarXXXX();
-    * to open dialogs for arrangement, use openDialogArrangement(JFrame, FlattenedScore);
-    * to open dialogs for live display, use openDialogLive(JFrame, DynamicScore)
+    * for notation, use **getNotationPanel()**
+    * for toolbars related with notation, use **getToolbarXXXX()**
+    * to open dialogs for arrangement, use **openDialogArrangement(JFrame, FlattenedScore)**
+    * to open dialogs for live display, use **openDialogLive(JFrame, DynamicScore)**
 9. To open dialogs, you need the corresponding score models, and it can be done by
-    * getScoreSymbols(): return the model of the original notations
-    * boolean parse(): parse notation to flattened score. If false returned, the notation may contain unsolved errors. In this case, use getErrorList() to see the error.
-    * boolean getScoreStatic(): return static score model. Use if after parse().
-    * boolean getScoreFlattened():  return flattened score model. Use if after parse().
-    * boolean getArragement(): build the arrangement model of the current flattened score model. 
-    * boolean getScoreDynamic(): build dynamic score based on the flattened score and the user's arrangement. 
+    * **getScoreSymbols()**: return the model of the original notations
+    * **boolean parse()**: parse notation to flattened score. If false returned, the notation may contain unsolved errors. In this case, use getErrorList() to see the error.
+    * **boolean getScoreStatic()**: return static score model. Use if after parse().
+    * **boolean getScoreFlattened()**:  return flattened score model. Use if after parse().
+    * **boolean getArragement()**: build the arrangement model of the current flattened score model. 
+    * **boolean getScoreDynamic()**: build dynamic score based on the flattened score and the user's arrangement. 
 
 If you want to know other functions of this API (which may not be as useful as the above), see [LSD API Usage].

WikiPage Home modified by SunnyFish

SunnyFish — Wed, 08 Aug 2012 16:14:08 -0000

--- v4
+++ v5
@@ -16,16 +16,17 @@
 ----------------
 **The fastest way**: use LDMainWindow, a fully-featured application as it is.
 **The standard way**: use LDController:
+
 1. set workplace
     * use setWorkplace(String dir) to set your workspace
     * retrieve names of folders that contains score images by getDirList()
     * set working folder by setDir(int index), the index is indicated by returned list of getDirList()
-2. get GUI component
++ get GUI component
     * for notation, use getNotationPanel()
     * for toolbars related with notation, use getToolbarXXXX();
     * to open dialogs for arrangement, use openDialogArrangement(JFrame, FlattenedScore);
     * to open dialogs for live display, use openDialogLive(JFrame, DynamicScore)
-3. To open dialogs, you need the corresponding score models, and it can be done by
+9. To open dialogs, you need the corresponding score models, and it can be done by
     * getScoreSymbols(): return the model of the original notations
     * boolean parse(): parse notation to flattened score. If false returned, the notation may contain unsolved errors. In this case, use getErrorList() to see the error.
     * boolean getScoreStatic(): return static score model. Use if after parse().

WikiPage Home modified by SunnyFish

SunnyFish — Wed, 08 Aug 2012 16:12:17 -0000

--- v3
+++ v4
@@ -1,5 +1,5 @@
 Live Score Display
-------
+===============
 Author: Zeyu Jin (Carnegie Mellon University) 
 
 Live Score Display (LSD for short) is an API for displaying musical score in live performance. This project is a part of Human-computer music performance which is intended to make virtual players (computers) cooperate with human in real music performance senario. The score display is such a virtual player who shows the proper part of score to human as music goes on. 
@@ -13,12 +13,29 @@
 For more detailed API usage, go to [LSD API Usage]. To get started quickly, please read on.
 
 Getting Started
----
+----------------
+**The fastest way**: use LDMainWindow, a fully-featured application as it is.
+**The standard way**: use LDController:
+1. set workplace
+    * use setWorkplace(String dir) to set your workspace
+    * retrieve names of folders that contains score images by getDirList()
+    * set working folder by setDir(int index), the index is indicated by returned list of getDirList()
+2. get GUI component
+    * for notation, use getNotationPanel()
+    * for toolbars related with notation, use getToolbarXXXX();
+    * to open dialogs for arrangement, use openDialogArrangement(JFrame, FlattenedScore);
+    * to open dialogs for live display, use openDialogLive(JFrame, DynamicScore)
+3. To open dialogs, you need the corresponding score models, and it can be done by
+    * getScoreSymbols(): return the model of the original notations
+    * boolean parse(): parse notation to flattened score. If false returned, the notation may contain unsolved errors. In this case, use getErrorList() to see the error.
+    * boolean getScoreStatic(): return static score model. Use if after parse().
+    * boolean getScoreFlattened():  return flattened score model. Use if after parse().
+    * boolean getArragement(): build the arrangement model of the current flattened score model. 
+    * boolean getScoreDynamic(): build dynamic score based on the flattened score and the user's arrangement. 
 
+If you want to know other functions of this API (which may not be as useful as the above), see [LSD API Usage]. 
 
-This is the default page, edit it as you see fit. To add a new page simply reference it within brackets, e.g.: [SamplePage].
-
-The wiki uses [Markdown](/p/livedisp/wiki/markdown_syntax/) syntax.
+FYI, this wiki uses [Markdown](/p/livedisp/wiki/markdown_syntax/) syntax.
 
 [[project_admins]]
 [[download_button]]

WikiPage Home modified by SunnyFish

SunnyFish — Wed, 08 Aug 2012 15:37:06 -0000

--- v2
+++ v3
@@ -10,7 +10,7 @@
 
 This API package is not just specialized for HCMP. You can wire it into your own application and control it yourself.
 
-For more detailed API usage, go to [LSD API usage]. To get started quickly, please read on.
+For more detailed API usage, go to [LSD API Usage]. To get started quickly, please read on.
 
 Getting Started
 ---