Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Topic/more words to help home #6141

Open
wants to merge 48 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
c6ecf70
more words to help home
prko Nov 17, 2023
b308b75
Update Help.schelp
prko Nov 17, 2023
7bd88bb
typo correction
prko Nov 17, 2023
78fc58a
more words to supercollider help document home
prko Nov 17, 2023
c007ab1
more words to supercollider help document home
prko Nov 17, 2023
2304a5b
Update Help.schelp
prko Nov 20, 2023
f08bb2f
Update scdoc.js
prko Nov 20, 2023
a085e5c
Update Help.schelp
prko Nov 20, 2023
40261ef
Update Help.schelp
prko Nov 20, 2023
055d947
Update scdoc.css
prko Nov 20, 2023
e643391
Update scdoc.css
prko Nov 20, 2023
5a51f68
Update scdoc.css
prko Nov 20, 2023
201fafe
Update Help.schelp
prko Nov 20, 2023
b58fbc5
Update Help.schelp
prko Nov 22, 2023
6b32df2
Merge branch 'supercollider:develop' into topic/more_words_to_help_home
prko Nov 22, 2023
36a99e6
Update Help.schelp
prko Nov 22, 2023
5aadfb7
Update Help.schelp
prko Nov 23, 2023
53e62fb
Update Help.schelp
prko Nov 25, 2023
935fd3f
Update HelpSource/Help.schelp
prko Nov 25, 2023
6055768
Update HelpSource/Help.schelp
prko Nov 25, 2023
a0efd76
Update HelpSource/Help.schelp
prko Nov 25, 2023
1200c89
Update HelpSource/Help.schelp
prko Nov 25, 2023
9f6fc4d
Update HelpSource/Help.schelp
prko Nov 25, 2023
dee3e2d
Update HelpSource/Help.schelp
prko Nov 25, 2023
26197fc
Update HelpSource/Help.schelp
prko Nov 25, 2023
bb01c39
Update HelpSource/Help.schelp
prko Nov 25, 2023
daa1f47
Update HelpSource/Help.schelp
prko Nov 25, 2023
b210c65
Update Help.schelp
prko Nov 25, 2023
3ee5a8f
Update Help.schelp
prko Nov 26, 2023
23e9da6
Update Help.schelp
prko Nov 26, 2023
2f1123d
Update scdoc.css
prko Nov 26, 2023
9797920
Update Help.schelp
prko Nov 26, 2023
2974058
Update Help.schelp
prko Nov 26, 2023
6b41ee5
Update Help.schelp
prko Nov 26, 2023
e6e5072
Update scdoc.css
prko Nov 26, 2023
5c37895
Update Help.schelp
prko Nov 26, 2023
9339b3e
Update Help.schelp
prko Dec 1, 2023
2485346
Update Help.schelp - alternative editor list part
prko Dec 6, 2023
dffe97e
Update Help.schelp alternative editors mentions only wiki in github
prko Dec 6, 2023
dae307e
Update Help.schelp
prko Dec 28, 2023
8775b0f
Update Help.schelp
prko Jan 5, 2024
2c0768c
Update Help.schelp
prko Jan 11, 2024
73eafe1
Merge branch 'supercollider:develop' into topic/more_words_to_help_home
prko Feb 3, 2024
24040c9
Update Help.schelp
prko Feb 3, 2024
cadd057
Update Help.schelp
prko Feb 3, 2024
2c48bce
Update Help.schelp
prko Feb 9, 2024
f166881
Same content with original layout (no tables)
prko Feb 9, 2024
499d585
Merge branch 'supercollider:develop' into topic/more_words_to_help_home
prko May 3, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
208 changes: 196 additions & 12 deletions HelpSource/Help.schelp
Original file line number Diff line number Diff line change
Expand Up @@ -2,37 +2,221 @@ TITLE::Help
summary::Documentation home
categories::Help

SuperCollider is an audio server, programming language, and IDE for sound synthesis and algorithmic composition.

NOTE:: link::Guides/News-3_13##News in SuperCollider version 3.13:: ::

SECTION::Search and browse

SECTION:: An introductory overview

emphasis::SuperCollider:: is a cross-platform environment for audio synthesis and algorithmic composition used by musicians, artists and researchers working with sound. It can be link::https://supercollider.github.io/downloads.html##installed:: and run on Linux, macOS and Windows,
as well as microcomputers such as
link::https://github.com/supercollider/supercollider/blob/develop/README_RASPBERRY_PI.md##Raspberry Pi:: and
link::https://github.com/supercollider/supercollider/blob/develop/README_BEAGLEBONE_BLACK.md##BeagleBone Black::.
emphasis::SuperCollider:: link::https://www.audiosynth.com##was originally developed:: by James McCartney and link::https://supercollider.github.io/##is now distributed:: as Free Software under the GNU General Public License. It link::https://github.com/supercollider/supercollider##is maintained and developed :: by an active and enthusiastic community.

emphasis::SuperCollider:: consists of three main components:

definitionlist::
## link::Search:: || Search all documents and methods
## link::Browse:: || Browse all documents by categories
## • soft:: ::link::Classes/Server:: – a real-time audio engine.||
The default server is link::Classes/Server#Switching the server application#scsynth::. To take full advantage of multi-core, an alternative sound engine, link::Classes/Server#Switching the server application#supernova::, can be used.

## • soft:: ::Client – sclang, a text-based programming language and interpreter. ||

emphasis::sclang:: controls audio synthesis processes on the server and offers an interactive programming environment for link::Overviews/JITLib##live coding::, an extensive library for creating link::Tutorials/A-Practical-Guide/PG_01_Introduction##patterns:: and a library of link::Classes/Scale##scales and modes:: from various cultures.
Creating link::Tutorials/Getting-Started/15-Sequencing-with-Routines-and-Tasks##processes:: that unfold over time is straightforward in emphasis::sclang::.
It also provides all the essential features of a graphical user interface (link::Guides/GUI-Introduction##GUI::) that can be used to create custom user interfaces, data visualization, and animations.
With support for
link::Guides/UsingMIDI##MIDI::,
link::Guides/OSC_communication##OSC::,
link::Guides/Working_with_HID##HID::, and
link::Classes/SerialPort##Serial Port::,
emphasis::sclang:: can be easily interfaced with local and networked hardware and software.

## • soft:: ::link::Classes/ScIDE:: – a dedicated editor for SuperCollider with an integrated help system.||
The SuperCollider Integrated Development Environment (link::Guides/SCIde##IDE::) allows you to start writing code right out of the box. Community members also maintain sclang integration with other popular IDEs. The full list of support editors is available at link::https://github.com/supercollider/supercollider/wiki/Systems-interfacing-with-SC#editors::
::

The server and client link::Guides/ClientVsServer##communicate:: via Open Sound Control (link::http://opensoundcontrol.org/##OSC::
), allowing SuperCollider to run on a single machine or on link::Guides/MultiClient_Setups##multiple machines:: over a network. Users can also control the audio server directly with any OSC-enabled program by using the link::Guides/NodeMessaging:: protocol.

An extensive library of Unit Generators—the building blocks of audio synthesis networks—are included with SuperCollider. Users may optionally extend this core library with the link::https://github.com/supercollider/sc3-plugins##sc3-plugins:: suite of UGens. Additionally, there are many of user-developed language extensions, called link::Classes/Quarks::, to further extend the functionality of SuperCollider. Quarks can be browsed in the distribution link::https://github.com/supercollider-quarks/quarks##repository:: where users can submit their own Quarks for distribution.


SECTION::Getting started

These are useful starting points for getting help on SuperCollider:

definitionlist::
## link::Tutorials/Getting-Started/00-Getting-Started-With-SC##Getting Started tutorial series:: || Get started with SuperCollider
## link::Guides/Glossary:: || Glossary
## link::Guides/ClientVsServer:: || Explaining the client vs server architecture
## link::Guides/More-On-Getting-Help:: || How to find more help
## link::Browse.html#Tutorials#All tutorials:: || Index of all help files categorized under "Tutorials"
## link::Guides/UserFAQ:: || Common Errors and FAQ
::

SECTION::Documentation indexes

definitionlist::
## link::Overviews/Documents:: || Alphabetical index of all documents
## link::Overviews/Classes:: || Alphabetical index of all classes
## link::Overviews/ClassTree:: || All classes by inheritance tree
## link::Overviews/Methods:: || Alphabetical index of all methods
SECTION:: Diving deeper

These are helpful for gaining a better grasp of SuperCollider:

subsection:: Getting Help

definitionList::
## Basics || list::
## link::Guides/How-to-Use-the-Interpreter::
## link::Guides/Understanding-Errors::
::
## Intermediate || list::
## link::Guides/Debugging-tips::
## link::Guides/Tracing-Processes::
## link::Guides/HID_permissions::
## link::Guides/LID_permissions::
::
## Advanced || list::
## link::Guides/Internal-Snooping::
::
::

subsection:: Language Reference

definitionList::
## Basics || list::
## link::Reference/Comments::
## link::Reference/Expression-Sequence::
## link::Guides/Intro-to-Objects::
## link::Reference/Classes::
## link::Reference/Messages::
## link::Guides/Polymorphism::
## link::Reference/Assignment::
## link::Reference/Scope::
## link::Reference/Functions::
::
## Intermediate || list::
## link::Reference/Control-Structures::
## link::Reference/Syntax-Shortcuts::
## link::Overviews/SymbolicNotations::
## link::Reference/Adverbs::
## link::Reference/Key-Value-Pairs::
## link::Reference/Literals::
::
## Advanced || list::
## link::Reference/Partial-Application::
## link::Guides/J-concepts-in-SC##Working with Multi-dimensional Arrays (J concepts in SC)::
## link::Guides/ListComprehensions::
## link::Guides/Tour-of-Special-Functions::
::
::

subsection:: Architecture

definitionList::
## Basics || list::
## link::Guides/ClientVsServer::
## link::Guides/UGens-and-Synths::
## link::Guides/NodeMessaging::
## link::Guides/Multichannel-Expansion::
## link::Guides/Order-of-execution::
## link::Reference/default_group::
::
## Intermediate || list::
## link::Guides/Server-Guide::
## link::Reference/Server-Architecture::
## link::Guides/MultiClient_Setups::
## link::Tutorials/Server_Tutorial::
## link::Reference/Server-Command-Reference::
## link::Guides/ServerTiming::
::
## Advanced || list::
## link::Guides/Bundled-Messages::
## link::Reference/Synth-Definition-File-Format::
::
::

subsection:: Overview

definitionList::
## Basics || list::
## link::Reference/AudioDeviceSelection::
## link::Guides/Tour_of_UGens::
## link::Overviews/Operators::
## link::Overviews/Collections::
## link::Overviews/GenericCollectors::
## link::Guides/Randomness::
::
## Intermediate || list::
## link::Overviews/Streams::
## link::Overviews/Event_types::
## link::Guides/GUI-Introduction::
## link::Overviews/GUI-Classes::
## link::Guides/GUI-Layout-Management::
::
## Advanced || list::
## link::Guides/FFT-Overview::
## link::Guides/Non-Realtime-Synthesis::
::
::

subsection:: Extending SC

definitionList::
## Basics || list::
## link::Reference/StartupFile::
## link::Guides/UsingExtensions::
## link::Guides/UsingQuarks::
::
## Intermediate || list::
## link::Guides/WritingClasses::
## link::Guides/standalones::
## link::Guides/WritingHelp::
## link::Reference/SCDocSyntax::
::
## Advanced || list::
## link::Guides/WritingTests::
## link::Guides/WritingUGens::
## link::Reference/ServerPluginAPI::
## link::Guides/WritingPrimitives::
::
::


subsection:: Sharing your work

definitionList::
## Style Guidelines || list::
## link::https://github.com/supercollider/supercollider/wiki/Style-Guidelines:-SuperCollider##SuperCollider::
::
## Share Code || list::
## http://sccode.org/
## link::https://scsynth.org/c/questions/code-review##Code Review on scsynth.org::
## link::https://scsynth.org/c/music/code-tennis##Code Tennis on scsynth.org::
::
## Share Music || list::
## link::https://scsynth.org/c/music##Music on scsynth.org::
::
::

subsection:: Contributing to SC

definitionList::
## Style Guidelines || list::
## link::https://github.com/supercollider/supercollider/wiki/Style-Guidelines:-SCDocs##SCDocs (schelp)::
## link::https://github.com/supercollider/supercollider/wiki/Style-Guidelines:-Cpp##C++ code::
::
## Discussing || list::
## link::https://scsynth.org/c/development##Development on scsynth.org::
::
## Developing || list::
## link::https://github.com/supercollider/supercollider##SuperCollider on GitHub::
::
::

subsection:: For more information


link:: https://github.com/supercollider/supercollider/wiki##SuperCollider Wiki::





SECTION::Licensing

Expand Down
16 changes: 15 additions & 1 deletion HelpSource/scdoc.css
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,20 @@ table {
font-size: 10pt;
margin-top: 1em;
margin-left: 2em;
width: calc(100% - 2em);
table-layout: auto;
}
table td {
border: 1px solid #ddd;
padding: 0.3em;
}

td ul {
list-style-type: disc;
margin-left: 1.75em;
padding: 0;
}

table table {
margin: 0em;
}
Expand Down Expand Up @@ -688,7 +696,7 @@ table#search_settings {
color: #555;
width: 100%;
margin-left: 0px;
margin-right: 0px;*/
margin-right: 0px;
margin: 0px;
padding: 0px;
border-collapse: collapse;
Expand Down Expand Up @@ -767,3 +775,9 @@ div.met_subclasses a.seemore {
font-size: 9pt;
color: #777;
}

@media only screen and (max-width: 200px) {
.table-content {
grid-template-columns: 1fr;
}
}
2 changes: 1 addition & 1 deletion HelpSource/scdoc.js
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ function fixTOC() {
var indexes_menu = $("<div>", {class: "submenu"}).hide()
.appendTo(li);

var nav_items = ["Documents", "Classes", "Methods"];
var nav_items = ["Documents", "Classes", "ClassTree", "Methods"];
nav_items.forEach(function (item) {
$("<a>", {
text: item,
Expand Down