Functions to provide mediated access to the SC3 help system.
- sc3HelpDirectory :: IO String
- sc3HelpClassFile :: FilePath -> String -> IO (Maybe FilePath)
- sc3HelpOperatorEntry :: FilePath -> String -> FilePath
- sc3HelpMethod :: FilePath -> Char -> (String, String) -> FilePath
- sc3HelpClassMethod :: FilePath -> (String, String) -> FilePath
- sc3HelpInstanceMethod :: FilePath -> (String, String) -> FilePath
- ugenSC3HelpFile :: String -> IO FilePath
- toSC3Name :: String -> String
- viewSC3Help :: String -> IO ()
Documentation
sc3HelpDirectory :: IO StringSource
Read the environment variable SC3_HELP
, the default value is
~/.local/share/SuperCollider
.
sc3HelpClassFile :: FilePath -> String -> IO (Maybe FilePath)Source
Locate path to indicated SC3 class help file.
sc3HelpDirectory >>= (flip sc3HelpClassFile) "SinOsc"
sc3HelpOperatorEntry :: FilePath -> String -> FilePathSource
Generate path to indicated SC3 operator help file.
sc3HelpOperatorEntry "." "+" == "./Overviews/Operators.html#.+"
sc3HelpMethod :: FilePath -> Char -> (String, String) -> FilePathSource
Generate path to indicated SC3 method help.
sc3HelpMethod "." '*' ("C","m") == "./Classes/C.html#*m"
sc3HelpClassMethod :: FilePath -> (String, String) -> FilePathSource
Generate path to indicated SC3 class method help.
sc3HelpClassMethod "." ("C","m") == "./Classes/C.html#*m"
sc3HelpInstanceMethod :: FilePath -> (String, String) -> FilePathSource
Generate path to indicated SC3 instance method help.
sc3HelpInstanceMethod "." ("C","m") == "./Classes/C.html#-m"
ugenSC3HelpFile :: String -> IO FilePathSource
The name of the local SC3 Help file documenting u
. Deletes
@
to allow use on haddock quoted comments.
ugenSC3HelpFile (toSC3Name "Collection.*fill") ugenSC3HelpFile (toSC3Name "Collection.inject") ugenSC3HelpFile (toSC3Name "sinOsc")
toSC3Name :: String -> StringSource
Convert from hsc3 name to SC3 name.
toSC3Name "sinOsc" == "SinOsc" toSC3Name "lfSaw" == "LFSaw" toSC3Name "pv_Copy" == "PV_Copy"
viewSC3Help :: String -> IO ()Source
Use x-www-browser to view SC3 help file for u
.
viewSC3Help (toSC3Name "Collection.*fill") viewSC3Help (toSC3Name "Collection.inject") viewSC3Help (toSC3Name "sinOsc")