Cchost/concepts/Commands - Revision history

Fourstones at 06:15, 9 June 2009

2009-06-09T06:15:40Z

Fourstones: /* ccHost is About Commands */

2008-11-13T11:21:15Z

‎ccHost is About Commands

Fourstones: New page: Category:ccHost Category:ccMixter Category:Developer Category:Software Category:Technology {{cchost_head}} {{lowercase}} =ccHost is About Commands= Get used to the idea...

2008-11-12T10:38:14Z

New page: Category:ccHost Category:ccMixter Category:Developer Category:Software Category:Technology {{cchost_head}} {{lowercase}} =ccHost is About Commands= Get used to the idea...

New page

[[Category:ccHost]]
[[Category:ccMixter]]
[[Category:Developer]]
[[Category:Software]]
[[Category:Technology]]
{{cchost_head}}
{{lowercase}}
=ccHost is About Commands=
Get used to the idea that ccHost is a command based system. Commands are appended to the base URL after the [[cchost/concepts/Virtual Roots|virtual root]].

http://ccmixter.org/media/people

HINT: Substitute your installation base URL for 'ccmixter.org' in these examples.

==Pretty URLs==
If you are using non-pretty-URLs then that command would like like:

http://ccmixter.org?ccm=/media/people

For purposes of brevity in this documentation we tend to assume 'pretty-URLs' (the same URL without the ''?ccm='') are enabled in your system.

==Stripping the Virtual Root==
As of ccHost 5.0 you can leave off the default virtual root ('''media''').

If the virtual root is '''media''' and the command is '''people''' that will display the latest users (with uploads). If the virtual root is left off, 'media' is assumed. So the same command can be stated:

http://ccmixter.org/people

==Command in This Documentation==
In this documentation there are many places where you are told to browse to some location and given a partial path, for example, '''admin/paths'''.

This is the command (and parameters if applicable) that you append to your installation root.

'''<nowiki>http://your_installation_root?ccm=/admin/paths</nowiki>''' Pretty URLs turned OFF

or

'''<nowiki>http://your_installation_root/admin/paths</nowiki>''' For pretty URLs turned ON

If the location in the documentation includes a '?' like:

'''api/query?tags=remix'''

then you need to convert that to an ampersand '&' if you have pretty URLs turned OFF because your URL already has a '?':

'''<nowiki>http://your_installation_root?ccm=/api/query&tags=remix</nowiki>''' Pretty URLs turned OFF

==Arguments==
Most command have parameters that are appended to the URL. For example '''people/antonov'''

command is still 'people', parameter is 'antonov' which displays anotov's user profile

=Command Reference=
As of version 5.0.1 you can browse to '''commands''' to see a list of all documented command.

To see undocumented commands (that is: a total dump of the URL map) browse to '''commands/0'''

@@ Line 5: / Line 5: @@
 [[Category:Technology]]
 {{cchost_head}}
 {{lowercase}}
 =ccHost is About Commands=
@@ Line 54: / Line 55: @@
 =Command Reference=
-As of version 5.0.1 you can browse to '''commands''' to see a list of all documented command.
+Browse to the following commands for various dumps:
-To see undocumented commands (that is: a total dump of the URL map) browse to '''commands/0'''
+* '''commands''' - all documented commands

@@ Line 7: / Line 7: @@
 {{lowercase}}
 =ccHost is About Commands=
-Get used to the idea that ccHost is a command based system. Commands are appended to the base URL after the [[cchost/concepts/Virtual Roots|virtual root]].
+Get used to the idea that ccHost is a command based system. Command are the done via URLs. They are the things you put into menus and navigation tabs when you are asked for 'command' or 'action' or 'URL'.
 http://ccmixter.org/media/people