some more scdoc syntax corrections in the docs

(cherry picked from commit 4ffaa5f)

HelpSource/Guides/Glossary.schelp

@@ -3,68 +3,90 @@ summary:: Glossary of some relevant words
 categories:: Help
 
 definitionlist::
+## buffer
 keyword:: buffer
-## buffer || A server-side header and array of 32 bit floating point sample data. Buffers are used for sound files, delay lines, arrays of global controls, and arrays of inter-synth patch points. Represented by the client-side class link::Classes/Buffer::.
+|| A server-side header and array of 32 bit floating point sample data. Buffers are used for sound files, delay lines, arrays of global controls, and arrays of inter-synth patch points. Represented by the client-side class link::Classes/Buffer::.
 
+## class
 keyword:: class
-## class || A description of the state and behaviour of a set of objects.
+|| A description of the state and behaviour of a set of objects.
 
+## client
 keyword:: client
-## client || SC is divided into two separate applications: The client and the server. The client is where the supercollider language is implemented and where one executes code. The server actually synthesizes the audio, contains the node tree of synths and groups and responds to Open Sound Control messages from the client. See link::Guides/ClientVsServer:: for more information.
+|| SC is divided into two separate applications: The client and the server. The client is where the supercollider language is implemented and where one executes code. The server actually synthesizes the audio, contains the node tree of synths and groups and responds to Open Sound Control messages from the client. See link::Guides/ClientVsServer:: for more information.
 
+## group
 keyword:: group
-## group || A linked list of nodes. Groups provide ways to control execution of many nodes at once. A group is a kind of node. Colloquially one can understand a group as an ordered grouping of other nodes, which may include both synths and other groups. Represented by the client-side class link::Classes/Group::.
+|| A linked list of nodes. Groups provide ways to control execution of many nodes at once. A group is a kind of node. Colloquially one can understand a group as an ordered grouping of other nodes, which may include both synths and other groups. Represented by the client-side class link::Classes/Group::.
 
+## interface
 keyword:: interface
-## interface || The set of messages to which an object responds.
+|| The set of messages to which an object responds.
 
+## instance
 keyword:: instance
-## instance || One of the objects described by a class.
+|| One of the objects described by a class.
 
+## instance variable
 keyword:: variable
-## instance variable || A part of an object's internal state
+|| A part of an object's internal state
 
+## message
 keyword:: message
-## message || A request for an object to perform an operation.
+|| A request for an object to perform an operation.
 
+## method
 keyword:: method
-## method || A description of the operations necessary to implement a message for a particular class.
+|| A description of the operations necessary to implement a message for a particular class.
 
+## MIDI
 keyword:: midi
-## MIDI || A protocol for sending music control data between synthesizers.
+|| A protocol for sending music control data between synthesizers.
 
+## node
 keyword:: node
-## node || One point in a tree of nodes executed in a depth first traversal order by the synth engine. There are two types of nodes, synths and groups. These are represented by the client-side classes link::Classes/Synth:: and link::Classes/Group::, and their abstract superclass link::Classes/Node::. The node tree defines the order of execution for synths.
+|| One point in a tree of nodes executed in a depth first traversal order by the synth engine. There are two types of nodes, synths and groups. These are represented by the client-side classes link::Classes/Synth:: and link::Classes/Group::, and their abstract superclass link::Classes/Node::. The node tree defines the order of execution for synths.
 
+## object
 keyword:: object
-## object || Something that has data, representing the object's state, and a set of operations that can be performed on the object.
+|| Something that has data, representing the object's state, and a set of operations that can be performed on the object.
 
+## Open Sound Control
 keyword:: OSC, opensoundcontrol
-## Open Sound Control || a protocol defined by CNMAT at UCBerkeley for controlling synthesizers. See http://opensoundcontrol.org/. SuperCollider communicates between the client and server using OSC messages over UDP or TCP.
+|| a protocol defined by CNMAT at UCBerkeley for controlling synthesizers. See http://opensoundcontrol.org/. SuperCollider communicates between the client and server using OSC messages over UDP or TCP.
 
-## OSC || See Open Sound Control.
+## OSC
+|| See Open Sound Control.
 
+## polymorphism
 keyword:: polymorphism
-## polymorphism	|| The ability for different kinds of objects to respond differently to the same message.
+|| The ability for different kinds of objects to respond differently to the same message.
 
+## protocol
 keyword:: protocol
-## protocol || A set of messages that implement a specific kind of behaviour.
+|| A set of messages that implement a specific kind of behaviour.
 
+## receiver
 keyword:: receiver
-## receiver || The object to which a message is sent.
+|| The object to which a message is sent.
 
+## server
 keyword:: server
-## server || SC is divided into two separate applications: The client and the server. The client is where the supercollider language is implemented and where one executes code. The server actually synthesizes the audio, contains the node tree of synths and groups and responds to Open Sound Control messages from the client. See See link::Guides/ClientVsServer:: for more information.
+|| SC is divided into two separate applications: The client and the server. The client is where the supercollider language is implemented and where one executes code. The server actually synthesizes the audio, contains the node tree of synths and groups and responds to Open Sound Control messages from the client. See See link::Guides/ClientVsServer:: for more information.
 
+## synth
 keyword:: synth
-## synth || A sound processing module, based upon a particular synth definition. Similar to "voice " in other systems. Synths are referred to by a number. Represented by the client-side class link::Classes/Synth::.
+|| A sound processing module, based upon a particular synth definition. Similar to "voice " in other systems. Synths are referred to by a number. Represented by the client-side class link::Classes/Synth::.
 
+## synth definition
 keyword:: synthdef
-## synth definition || A definition for creating new synths. Synth definitions are like a pattern or design for synths. Similar to "instrument" in other systems. Represented by the client-side class link::Classes/SynthDef::.
+|| A definition for creating new synths. Synth definitions are like a pattern or design for synths. Similar to "instrument" in other systems. Represented by the client-side class link::Classes/SynthDef::.
 
+## TCP
 keyword:: tcp
-## TCP || A protocol for streaming data over a network.
+|| A protocol for streaming data over a network.
 
+## UDP
 keyword:: udp
-## UDP || A protocol for sending datagrams over a network.
+|| A protocol for sending datagrams over a network.
 ::

HelpSource/Guides/J-concepts-in-SC.schelp

@@ -212,7 +212,7 @@ a.reshapeLike(b);
 b.reshapeLike(a);
 ::
 If the lengths are different, the default behaviour is to wrap:
-code:
+code::
 a = [[10,20],[30, 40, 50]];
 b = [[1, 2, [3, 4], [[5], 6], 7], 8, [[9]]];
 a.reshapeLike(b);

HelpSource/Guides/News-3_5.schelp

@@ -62,7 +62,7 @@ subsection:: PriorityQueue stable order
 
 The link::Classes/PriorityQueue:: now provides a stable heap order: items of the same time value will have a FIFO order.
 
-subsection:: link::Reference/plot:: improvements
+subsection:: plot improvements
 
 link::Reference/plot:: has been changed to use the link::Classes/Plotter:: class, which was formerly used by the code::plot2:: methods. code::plot2:: has been deprecated, the old behavior is still available via the code::plotOld:: methods, which have also been deprecated.
 

HelpSource/Guides/SuperColliderAU.schelp

@@ -29,7 +29,7 @@ section::Inside the bundle
 
 As an AudioUnit plugin, SuperColliderAU is packaged in a component bundle. All the files needed by SuperColliderAU can be found in the Resources folder inside the bundle:
 
-subsection::serverConfig.plist::
+subsection::serverConfig.plist
 Stores configuration parameters for the server (see link::Classes/ServerOptions::)
 
 list::
@@ -41,13 +41,13 @@ list::
 ## BeatDiv: For linking Demand Ugens to the Host tempo. If this number is set, SuperColliderAU wil trigger bus 0 each beat division and use bus 1 for reset.
 ::
 
-subsection::pluginSpec.plist::
+subsection::pluginSpec.plist
 Stores parameter configuration for standalone plugins. SuperColliderAU will use this to display and set the parameters of your synth definition. Note that the defalt values must be the same for the synth definition, they wil not be set by the wrapper. The value in this file is only for display.
 
-subsection::synthdefs::
+subsection::synthdefs
 For standalone plugins you should have your synth definition here. When controlling the server remotely you can just send the synth definitions.
 
-subsection::plugins::
+subsection::plugins
 Here you need all the SC plugins you intend to use with that server.
 
 section::Making standalone plugins

HelpSource/Guides/UsingExtensions.schelp

@@ -29,27 +29,34 @@ table::
 
 section:: How Extensions Folders Should be Organised
 
-warning::The following section describes the old OSX-based extension directory layout. This is subject to change.::
-
-Class files and UGen plugins are recognised by their file extensions. Anything placed within a folder named help/ or
-ignore/ (case insensitive) will be ignored when compiling the class library or loading plugins, but anything in the
-former will be added to the search path for help files.
+Class files and UGen plugins are recognised by their file extensions. Anything placed within a folder named 
+teletype::ignore/:: (case insensitive) will be ignored when compiling the class library or loading plugins.
 
 Here is an example folder layout:
 
+teletype::MyExtension::
 tree::
-## teletype::MyExtension::
+## teletype::classes::
     tree::
-    ## teletype::classes::
+    ## teletype::myClass.sc::
+    ## teletype::myUGens.sc::
+    ::
+## teletype::plugins::
     tree::
-        ## teletype::myClass.sc myUGens.sc::
-        ::
-    ## teletype::plugins::
+    ## teletype::myUGenPlugins.scx::
+    ::
+## teletype::HelpSource::
     tree::
-        ## teletype::myUGenPlugins.scx::
+    ## teletype::Classes::
+        tree::
+        ## teletype::MyClass.schelp::
+        ## teletype::MyUGen1.schelp::
+        ## teletype::MyUGen2.schelp::
         ::
-    ## teletype::help::
-    tree::
-        ## teletype::myClass.html myUGen1.html myUGen2.html::
+    ## teletype::Guides::
+        tree::
+        ## teletype::MyExtensionGuide.schelp::
         ::
+    ::
 ::
+

HelpSource/Guides/WritingUGens.schelp

@@ -1,7 +1,6 @@
 title:: Writing Unit Generators
 summary:: Get started with writing unit generators
 categories:: Internals
-related::
 
 section:: How Unit Generator plug-ins work.
 

HelpSource/Overviews/SC3vsSC2.schelp

@@ -12,5 +12,5 @@ definitionList::
 ## link::Guides/Backwards-Compatibility:: || A discussion some classes and methods which have been added to improve compatibility with SC2 code, and their limitations.
 ::
 
-note:: These documents are not intended to be exhaustive tutorials, just an introduction to some of the differences. Close examination of the helpfiles of relevant classes should help to fill in the details. These files may be of some use to beginners as well.
+note:: These documents are not intended to be exhaustive tutorials, just an introduction to some of the differences. Close examination of the helpfiles of relevant classes should help to fill in the details. These files may be of some use to beginners as well.::
 

HelpSource/Overviews/SymbolicNotations.schelp

@@ -149,6 +149,7 @@ Rect(left, top, right-left, bottom-top)
 ## code:: ugen @ ugen :: || create a Point with two link::Classes/UGen::s
 ## code:: rect & rect :: || intersection of two rectangles
 ## code:: rect | rect :: || union of two rectangles (returns a Rect whose boundaries exactly encompass both Rects)
+::
 
 section:: IOStream operators
 definitionlist::

HelpSource/Tutorials/A-Practical-Guide/PG_03_What_Is_Pbind.schelp

@@ -97,7 +97,7 @@ list::
 ::
 ## strong::Legacy::
 list::
-## emphasis::Symbol as pitch: :: A symbol, such as strong::\rest::, strong::\r:: or even the empty symbol strong::\::, in a key related to pitch (degree, note, midinote, freq) causes the event to be silent.
+## emphasis::Symbol as pitch: :: A symbol, such as strong::\rest::, strong::\r:: or even the empty symbol strong:: \ ::, in a key related to pitch (degree, note, midinote, freq) causes the event to be silent.
 ## emphasis::\type, \rest: :: Setting the event's \type to \rest also silences the event.
 ::
 ::

HelpSource/Tutorials/A-Practical-Guide/PG_04_Words_to_Phrases.schelp

@@ -185,6 +185,7 @@ list::
 ## code::Pbind(\someValue, Psym(**, (pattern1: Pwhite(**))) ::
 ::
 ::
+::
 
 subsection::Switching between patterns for individual values
 

HelpSource/Tutorials/A-Practical-Guide/PG_08_Event_Types_and_Parameters.schelp

@@ -400,6 +400,7 @@ Very important: Arrays normally multi-channel expand in patterns. So, you must w
 ::
 ::
 ::
+::
 
 subsection::Miscellaneous
 

HelpSource/Tutorials/JITLib/jitlib_basic_concepts_03.schelp

@@ -81,7 +81,8 @@ code::
 ~z = { max(SinOsc.ar(ExpRand(3, 160)), Saw.ar([304, 304.3])) * 0.1 };
 ::
 
-note that the fadeTime is also used for the operations xset and xmap. (see below)
+note::
+the fadeTime is also used for the operations xset and xmap. (see below)
 ::
 
 section::c) play/stop, send/free, pause/resume

HelpSource/Tutorials/JITLib/proxyspace_examples.schelp

@@ -1,9 +1,9 @@
-title:: proxyspace_examples
-summary:: proxy space examples
+title:: ProxySpace examples
+summary:: Some ProxySpace examples
 categories:: Libraries>JITLib>Tutorials
 related:: Overviews/JITLib, Classes/ProxySpace
 
-
+section::main examples
 
 subsection::preparing the environment
 

HelpSource/Tutorials/Mark_Polishook_tutorial/04_Help.schelp

@@ -55,7 +55,7 @@ David Cottle has a large course on sound synthesis based around SC3.
 A course by Nick Collins:
 
 list::
-http://www.informatics.sussex.ac.uk/users/nc81/courses/cm1/workshop.html
+## http://www.informatics.sussex.ac.uk/users/nc81/courses/cm1/workshop.html
 ::
 
 The pseudonym tutorial:

HelpSource/Tutorials/Mark_Polishook_tutorial/08_Rates.schelp

@@ -48,4 +48,5 @@ Type command-period (cmd-.) to stop synthesis.
 
 ////////////////////////////////////////////////////////////////////////////////////////////////////
 
-Go to link::Tutorials/Mark_Polishook_tutorial/09_Buses
+Go to link::Tutorials/Mark_Polishook_tutorial/09_Buses::
+

HelpSource/Tutorials/Mark_Polishook_tutorial/14_Subtractive_synthesis.schelp

@@ -19,7 +19,7 @@ Filter.dumpClassSubtree;
 
 ////////////////////////////////////////////////////////////////////////////////////////////////////
 
-classtree::Filter::
+classtree::Filter
 
 ////////////////////////////////////////////////////////////////////////////////////////////////////
 

HelpSource/Tutorials/Mark_Polishook_tutorial/Japanese_version/10.schelp

@@ -15,7 +15,7 @@ code::
 Filter.dumpClassSubtree;
 ::
 
-classtree::Filter::
+classtree::Filter
 
 SuperColliderのヘルプ・システムでHelp/UGens/Filtersを調べることでもフィルターのヘルプ・ファイルをみることができます。ヘルプ・ファイルの全てにはそれぞれのフィルターがどのように動作するのかを示す素晴らしい例があります。
 

HelpSource/Tutorials/Tutorial.schelp

@@ -25,7 +25,8 @@ s = Server.internal;
 
 strong::VERY IMPORTANT:: : This line must be executed for the variable 's' to be set. The mechanics are different depending on your platform. The MacOSX standard is to place the cursor anywhere on this line and press the "Enter" key on the numeric keypad. Pressing the main return key does not execute code! This allows you to write code fragments of multiple lines. To execute a multi-line block of code, select the block and press "Enter." For convenience, a code block can be enclosed in parentheses, and the entire block selected by double-clicking just inside either parenthesis. (For instructions in other editors (e.g. on Linux or Windows), consult the documentation specific to that platform. See also the helpfile link::Reference/KeyboardShortcuts:: for key commands in other editors.) If you don't have an enter key, then you can use ctrl-Return, Ctrl-c, fn-Return (on Some Macs), or Shift-Return.
 
-The local server runs on the same machine as the SuperCollider application, but is a separate program, 'scsynth'. strong::Note:: : By default the interpreter variable code::s:: is set to the local server at startup. For further information see the link::Classes/Server:: helpfile.
+The local server runs on the same machine as the SuperCollider application, but is a separate program, 'scsynth'.
+Note:: By default the interpreter variable code::s:: is set to the local server at startup. For further information see the link::Classes/Server:: helpfile.
 ::
 
 code::