[jokosher-devel] Fwd: doc patch



resend of bounced mail

---
First mail to the new list!!!    All thanks to our benevolent GNOME overlords!

Here's my latest patch against doc/userguide/jokosheruserguide.html.
This brings us up to my working copy, but there are some changes on
the Wiki still to be included.

--
Jeff Ratliff (Gomer_X)
Index: jokosheruserguide.html
===================================================================
--- jokosheruserguide.html	(revision 446)
+++ jokosheruserguide.html	(working copy)
@@ -51,11 +51,11 @@
 documenting. We <span style="font-style: italic;">really, really</span>
 don't want this to happen with Jokosher. Our lovingly crafted Jokosher
 is made for musicians, and we want it to be simple and easy to use, and
-this guide plays n essential role. If something is incorrect, outdated
+this guide plays an essential role. If something is incorrect, outdated
 or just plain broken, roll up your sleeves and fix it. It will be a
 great contribution to this important project.<br>
 <h2><a name="2._Installation"></a>2. Installation</h2>
-###FIXME###
+###FIXME### <i>This is just pending some type of installation system being put in place.</i>
 <h2><a name="3._Getting_Started"></a>3. Getting Started</h2>
 Fire up Jokosher by selecting <span style="font-weight: bold;">Applications -&gt; Sound &amp; Video -&gt; Jokosher</span>.<br>
 <br>
@@ -109,7 +109,7 @@
 <h2><a name="The_Main_Jokosher_Window"></a>The Main Jokosher Window</h2>
 The main Jokosher window is where the action happens (Figure 3-2):<br>
 <br>
-<img style="width: 910px; height: 579px;" alt="The main Jokosher window" src="images/mainwindow.png"><br>
+<img style="width: 800px; height: 509px;" alt="The main Jokosher window" src="images/mainwindow2.png"><br>
 <span style="font-weight: bold;">Figure 3-2</span><br>
 <span style="font-style: italic;">The main Jokosher screen<br>
 <br>
@@ -118,11 +118,10 @@
 inside a single window, making it simple to see what is going on at any
 one time.<br>
 <br>
-Along the top side of the screen you can see a bunch of menus. You can
-find virtually everything in those menus, and if you are stuck figuring
-out how to do something, flick through the menus. Below the menus are
-the main toolbar buttons. These buttons are nice and big to help you
-when perched over your desk holding your guitar. They do a bunch of
+
+<h3><a name="The_Toolbar"></a>The Toolbar</h3>
+Below the menus are the main toolbar buttons. These buttons are nice and big to
+help you when perched over your desk holding your guitar. They do a bunch of
 interesting things:<br>
 <ul>
   <li><span style="font-weight: bold;">Add Instrument</span> - click this button to add an instrument to the project. See <a href="#Adding_Instruments">Adding Instruments</a>.</li>
@@ -133,29 +132,69 @@
   <li><span style="font-weight: bold">Time Scale</span> - this ruler gives you a visual representation of your project in time. You can use it to determine at a glance where in time events in your project occur. The scale will be in measures or seconds, depending on you current time format.</li>
   <li><span style="font-weight: bold">Project Zoom</span> - this area at the bottom of the main window will help you zoom in and out and scroll the project quickly. The minus and plus icons will zoom the time scale out and in respectively. The center icon will return you to a medium zoom. Drag the scroll bar to move the visible area of your project if it doesn't all fit on the screen.</li>
 </ul>
-o<br>
+<br>
+
 <h3><a name="The_Menus"></a>The Menus</h3>
-<h4><a name="File"</a>File</h4>
-###FIXME###<br>
-<h4><a name="Edit"</a>Edit</h4>
-###FIXME###<br>
-<h4><a name="Project"</a>Project</h4>
-###FIXME###<br>
-<h4><a name="Help"</a>Help</h4>
-###FIXME###<br>
+Along the top side of the screen you can see a bunch of menus. You can find
+virtually everything in those menus, and if you are stuck figuring out how to
+do something, flick through the menus. <br>
 
-<h3><a name="The_Workspaces"></a>The Workspaces</h3>
+<h4><a name="File"></a>File</h4>
 <ul>
-	<li><span style="font-weight: bold;">Recording View</span> - inside the recording view, only the instruments are displayed. This is where you will spend most of your time recording, editing and re-recording.</li>
-
-	<li><span style="font-weight: bold;">Mixing View</span> - this is the main mixing view. This view displays smaller versions of your instrument tracks as well as mixing sliders for adjusting instrument volume levels. This is where you mix your final project.</li>
+	<li><span style="font-weight: bold;">New</span> - opens a new project in the existing window. If there are changes in the current project, you will be offered a chance to save. To add an instrument to the open project, see <a href="#Adding_Instruments">Adding Instruments</a>.</li>
+	<li><span style="font-weight: bold;">Open</span> - opens an existing project. If there are changes in the current project, you will be offered a chance to save.</li>
+	<li><span style="font-weight: bold;">Save</span> - saves the current project. This option quickly saves all information in the project including Undo and Redo history.</li>
+	<li><span style="font-weight: bold;">Save As</span> - same as Save above, but this option allows you to save the project under a different name.</li>
+	<li><span style="font-weight: bold;">Close</span> - closes the current project without closing Jokosher. Again, you'll get a chance to save the project if there are changes.</li>
+	<li><span style="font-weight: bold;">Recent Projects</span> - this submenu lists up to the last 8 projects opened in Jokosher. This is a convenient way to move quickly from one project to another.</li>
+	<li><span style="font-weight: bold;">Mixdown Project</span> - brings up a dialog that begins the final stage of your project - the mixdown. Choose a name for the output file, a location where you want it saved, and an output format. Jokosher will then mix the project and save it as a single audio file in your chosen format.</li>
+	<li><span style="font-weight: bold;">Quit</span> - quits Jokosher completely. You will get a chance to save any unsaved work.</li>
 </ul>
+<h4><a name="Edit"></a>Edit</h4>
+<ul>
+	<li><span style="font-weight: bold;"> Undo</span> - ###FIXME###</li>
+	<li><span style="font-weight: bold;">Redo</span>- ###FIXME### </li>
+	<li><span style="font-weight: bold;">Cut</span> - ###FIXME### </li>
+	<li><span style="font-weight: bold;">Copy</span> - ###FIXME### </li>
+	<li><span style="font-weight: bold;">Paste</span> - ###FIXME### </li>
+	<li><span style="font-weight: bold;">Delete</span> - ###FIXME### </li>
+	<li><span style = "font-weight: bold;">Preferences</span></li>
+	<ul>
+		<li><span style = "font-weight: bold;">General</span></li>
+		<ul>
+			<li><span style = "font-weight: bold;">Application Start-up</span> - ###FIXME###</li>
+			<li><span style = "font-weight: bold;">Audio Quality</span> - ###FIXME###</li>
+			<li><span style = "font-weight: bold;">Audio Mixdown</span> - ###FIXME###</li>
+		</ul>
+		<li><span style = "font-weight: bold;">Recording</span></li>
+		<ul>
+			<li><span style = "font-weight: bold;">Quality</span> - ###FIXME###</li>
+		</ul>
+		<li><span style = "font-weight: bold;">Playback</span></li>
+		<ul>
+			<li><span style = "font-weight: bold;">Quality</span> - ###FIXME###</li>
+		</ul>
+	</ul>
+</ul>
+<h4><a name="Project"></a>Project</h4>
+<ul>
+	<li><span style="font-weight: bold;">Add Instrument</span> - see <a href="#Adding_Instruments">Adding Instruments</a> below</li>
+	<li><span style="font-weight: bold;">Instrument Connections</span> - ###FIXME###</li>
+	<li><span style="font-weight: bold;">Time Format</span> - ###FIXME###</li>
+</ul>
+<h4><a name="Help"></a>Help</h4>
+###FIXME###
 
-###FIXME###<br>
-<h3><a name="Adding_Instruments"></a>Adding Instruments</h3>
+<h3><a name="The_Workspaces"></a>The Workspaces</h3>
+<h4>Recording View</h4>
+Inside the recording view, only the instruments are displayed. This is where you will spend most of your time recording, editing and re-recording.<br>
+###FIXME### <i>basic description of functions specific to Recording view go here. A brief description of adding an instrument and recording to it would be good</i>
+<h4>Mixing View</h4>
+this is the main mixing view. This view displays smaller versions of your instrument tracks as well as mixing sliders for adjusting instrument volume levels. This is where you mix your final project.<br>
+###FIXME### <i>basic description of functions specific to Mixing view go here. A brief description of setting volume levels and preparing for final mix would be good</i>
+<h4><a name="Adding_Instruments"></a>Adding Instruments</h4>
 Instruments are a key concept in Jokosher. Think in Instruments instead of Tracks. Instruments allow you to tell a lot about your project at a glance. Tracks are just tracks!<br/><br/>
 Currently, instruments are very simple - they just contain the name and icon of the instrument. In the future we plan on storing audio settings for each type of instrument. As an example when you use a Snare drum, the EQ will be  optimised for a Snare drum.<br/>
-###FIXME###<br>
 <br>
 <br>
 <img style="width: 360px; height: 323px;" alt="Adding instruments is simple" src="images/addinstrumentdialog.png"><br>
@@ -164,7 +203,7 @@
 </span><br>
 To add and instrument, click on the <span style="font-weight: bold;">Add Instrument</span> button to bring up the dialog. Simply pick the instrument that is closest to what you'll be recording. Click <span style="font-weight: bold;">OK</span> and you're done. <br/><br/>
 Notice that once an instrument is added, you can click on its name and change it to anything you want. If you want to remove an instrument for any reason, just select it and hit the <span style="font-weight: bold;">delete</span> key on your keyboard.<br/>
-<h1><a name="Configuring_Jokosher_Preferences"></a>Configuring Jokosher Preferences</h1>
-###FIXME###<span style="font-style: italic;"></span><span style="font-style: italic;"></span>
+<h3><a name="Configuring_Jokosher_Preferences"></a>Configuring Jokosher Preferences</h3>
+###FIXME### <i>Do we need this at all? Thinking of moving it to <b>Menus-&gt;Edit-&gt;Preferences</b> above</i>
 </body>
 </html>


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]