HelpSource/Tutorials/Mark_Polishook_tutorial/04_Help.schelp

   1 title:: 04_Help
   2 summary:: Mark Polishook tutorial
   3 categories:: Tutorials>Mark_Polishook_tutorial
   4 related:: Tutorials/Mark_Polishook_tutorial/00_Introductory_tutorial
   5
   6 section::Help
   7
   8 SuperCollider has a built-in help system. To see the main help page, press cmd-d (without first selecting anything). From that page, click on underlined topics. Another useful document is link::Guides/More-On-Getting-Help::.
   9
  10 In general, there are help files for classes (capitalized words, such as SinOsc, Array, Nil, etc.). Select the name of a class and press Cmd-d. A help file, if one exists, will open.
  11
  12 section::Class definitions, message implementations, and the Find command
  13
  14 To see source code for class definitions, select the name of a class and type cmd-j
  15
  16 To see how a class or classes implement a particular message, select the message name and press cmd-y.
  17
  18 Use the Find and Find Next commands, available through the Edit menu, to search for text in the frontmost document
  19
  20 section::grep
  21
  22 Use grep in the Terminal (in the Applications->Utilities folder) to search for all occurences of a given word or phrase. For example, to see all documents that use the LFSaw class, evaluate (in the Terminal application)
  23
  24 code::
  25 grep -r LFSaw /Applications/SuperCollider
  26 ::
  27
  28 Because lines in the terminal application break according to the size of the window and not through schemes that enhance readability, it may be easier to write grep results to a file, as in
  29
  30 code::
  31 // change the name of the path (the argument after the '>' sign, as appropriate
  32 grep -r LFSaw /Applications/SuperCollider/ > /Users/yourHomeDirectory/Desktop/grep_results
  33 ::
  34
  35 section::Additional sources
  36
  37 The SuperCollider wiki:
  38 list::
  39 ## http://swiki.hfbk-hamburg.de:8888/MusicTechnology/6
  40 ::
  41
  42 The SuperCollider users mailing list archive:
  43 list::
  44 ## http://www.listarc.bham.ac.uk/marchives/sc-users/
  45 ::
  46
  47 The SuperCollider user or developer lists (or both).
  48
  49 list::
  50 ## http://www.beast.bham.ac.uk/research/sc_mailing_lists.shtml
  51 ::
  52
  53 David Cottle has a large course on sound synthesis based around SC3.
  54
  55 A course by Nick Collins:
  56
  57 list::
  58 ## http://www.informatics.sussex.ac.uk/users/nc81/courses/cm1/workshop.html
  59 ::
  60
  61 The pseudonym tutorial:
  62
  63 list::
  64 ## http://www.psi-o.net/pseudonym/
  65 ::
  66
  67 The MAT tutorial (UC-Santa Barbara) tutorial:
  68
  69 list::
  70 ## http://www.mat.ucsb.edu/~sc/
  71 ::
  72
  73 ////////////////////////////////////////////////////////////////////////////////////////////////////
  74
  75 go to link::Tutorials/Mark_Polishook_tutorial/05_The_network::