Difference between revisions of "CcHost5Documentation"

From Creative Commons
Jump to: navigation, search
Line 8: Line 8:
 
ccHost URLs are composed of four main parts:
 
ccHost URLs are composed of four main parts:
  
  1. Root URL of installation
+
1. Root URL of installation
 +
* This is the URL address of where index.php lives. For example: http://example.com, or http://example.com/cchost
  
      This is the URL address of where index.php lives. For example: http://example.com, or http://example.com/cchost
+
2. Virtual Root
  2. Virtual Root
+
* Don't worry if you don't know what a 'ccHost virtual root' is, we'll get to it here but for now assume it's the word media.
  
      Don't worry if you don't know what a 'ccHost virtual root' is, we'll get to it here but for now assume it's the word media.
+
3. Command
  3. Command
+
* This part of the URL maps to an internal command in ccHost. This can be anything from a request for a submit form, a feed, a record listing, etc. Examples are people which shows a listing of the latest registered users who have uploaded or files which lists the latest uploads.
  
      This part of the URL maps to an internal command in ccHost. This can be anything from a request for a submit form, a feed, a record listing, etc. Examples are people which shows a listing of the latest registered users who have uploaded or files which lists the latest uploads.
+
4. Parameters
  4. Parameters
+
* Many if not most commands accept and even require parameters. For example, adding a specific user's name to the people command will display the user's main page, e.g. people/rejon
 
 
      Many if not most commands accept and even require parameters. For example, adding a specific user's name to the people command will display the user's main page, e.g. people/rejon
 
  
 
You should refer to the ccHost Command Reference for a listing of all available commands.
 
You should refer to the ccHost Command Reference for a listing of all available commands.

Revision as of 22:59, 1 July 2008

THIS IS A DRAFT PAGE - DO NOT TRUST ANY INFORMATION ON IT

Understanding ccHost URLs

Understanding how URLs work in ccHost is a very important concept that you should understand before doing anything else. URL Parts

ccHost URLs are composed of four main parts:

1. Root URL of installation

2. Virtual Root

  • Don't worry if you don't know what a 'ccHost virtual root' is, we'll get to it here but for now assume it's the word media.

3. Command

  • This part of the URL maps to an internal command in ccHost. This can be anything from a request for a submit form, a feed, a record listing, etc. Examples are people which shows a listing of the latest registered users who have uploaded or files which lists the latest uploads.

4. Parameters

  • Many if not most commands accept and even require parameters. For example, adding a specific user's name to the people command will display the user's main page, e.g. people/rejon

You should refer to the ccHost Command Reference for a listing of all available commands.

If you have enabled 'pretty URLs' in your installation then all the elements are strung together into one URL:

http://example.com/media/people/rejon

If not, then everything starting from the virtual root is prepended the following way:

http://example.com?ccm=/media/people/rejon