HelpSource/Classes/Quarks.schelp

   1 class:: Quarks
   2 summary:: Package manager
   3 categories:: Quarks
   4 related:: Classes/Quark, Guides/UsingQuarks, Classes/QuarkSVNRepository, Classes/LocalQuarks
   5
   6 description::
   7 See link::Guides/UsingQuarks:: for more information.
   8
   9 CLASSMETHODS::
  10 private:: initClass
  11
  12 METHOD:: gui
  13 Show GUI to manage quarks.
  14
  15 METHOD:: global
  16 The singleton Quarks instance.
  17
  18 METHOD:: checkoutAll
  19 Check out all quarks (does not install them)
  20
  21 METHOD:: listCheckedOut
  22 List all checked out quarks.
  23
  24 METHOD:: listAvailable
  25 List all available quarks.
  26
  27 METHOD:: listInstalled
  28 List all installed quarks.
  29
  30 METHOD:: updateDirectory
  31 Makes sure you have an up-to-date directory listing.
  32
  33 METHOD:: checkout
  34 Check out a specific quark.
  35
  36 argument:: name
  37 Name of quark to checkout.
  38
  39 argument:: version
  40 A link::Classes/Float:: indicating which version of the quark to checkout.
  41
  42 argument:: sync
  43 A link::Classes/Boolean::
  44
  45 METHOD:: install
  46 Install a specific quark, by linking it into the user extensions folder.
  47
  48 argument:: name
  49 Name of quark.
  50
  51 argument:: includeDependencies
  52 A link::Classes/Boolean::
  53
  54 argument:: checkoutIfNeeded
  55 A link::Classes/Boolean::
  56
  57 METHOD:: uninstall
  58 Uninstall quark.
  59
  60 argument:: name
  61 Name of quark.
  62
  63 METHOD:: update
  64 Update quark to latest revision.
  65
  66 argument:: quarkName
  67 Name of quark.
  68
  69 METHOD:: installed
  70 Get a list of all installed quarks.
  71
  72 METHOD:: isInstalled
  73 Check if a quark is installed.
  74
  75 argument:: name
  76 Name of quark.
  77
  78 METHOD:: local
  79 An instance of link::Classes/LocalQuarks::
  80
  81 METHOD:: help
  82 Open help for specific quark.
  83
  84 argument:: name
  85 Name of quark.
  86
  87
  88 INSTANCEMETHODS::
  89 note:: This document needs updating ::
  90