Difference between revisions of "CcHost5Documentation"

From Creative Commons
Jump to: navigation, search
(Added layout of Administrative Settings)
Line 32: Line 32:
 
http://example.com?ccm=/media/people/rejon
 
http://example.com?ccm=/media/people/rejon
  
=Admin Settings=
+
=Administrative Settings=
  
==Settings==
+
==Manage Site==
 +
 
 +
===Settings===
 
Admins, editors, etc.
 
Admins, editors, etc.
  
==Skin==
+
===Skin===
 
Choose a skin, theme, layout, colors, fonts, etc.
 
Choose a skin, theme, layout, colors, fonts, etc.
  
==Navigator Tab Sets==
+
===Navigator Tab Sets===
 
Create and edit navigator tabs
 
Create and edit navigator tabs
  
==File Formats==
+
===File Formats===
 
Pick which file formats are allowed to be uploaded
 
Pick which file formats are allowed to be uploaded
  
==License==
+
===License===
 
Pick which licenses a user is allowed to select from
 
Pick which licenses a user is allowed to select from
  
==Upload Renaming==
+
===Upload Renaming===
 
Configure how uploads are automatically renamed
 
Configure how uploads are automatically renamed
  
==Submit Forms==
+
===Submit Forms===
 
Edit what kind of submit forms the user can see
 
Edit what kind of submit forms the user can see
  
==Banner and Footers==
+
===Banner and Footers===
 
Edit what the banner and footer says on each page.
 
Edit what the banner and footer says on each page.
  
==Sidebar Extras==
+
===Sidebar Extras===
 
Pick what features are available on the side bar.
 
Pick what features are available on the side bar.
  
==Menus==
+
===Menus===
 
Edit the menus
 
Edit the menus
  
==ID3 Tagger==
+
===ID3 Tagger===
 
Configure how to tag ID3 compatible files (e.g. MP3s)
 
Configure how to tag ID3 compatible files (e.g. MP3s)
  
==Menu Groups==
+
===Menu Groups===
 
Edit the menu groups
 
Edit the menu groups
  
==Thumbnails==
+
===Thumbnails===
 
Configure thumbnails handling (for image uploads)
 
Configure thumbnails handling (for image uploads)
  
=Global Settings=
+
==Global Settings==
  
==Admin Help==
+
===Admin Help===
 
Help on configuring the site
 
Help on configuring the site
  
==Global Setup==
+
===Global Setup===
 
Cookies, ban message, admin email, 3rd party add ins, etc.
 
Cookies, ban message, admin email, 3rd party add ins, etc.
  
==Manage Page Content==
+
===Manage Page Content===
 
Manage special pages and topics
 
Manage special pages and topics
  
==Paths==
+
===Paths===
 
Configure where ccHost looks for stuff
 
Configure where ccHost looks for stuff
  
==Forum==
+
===Forum===
 
Configure forums access, groups, etc.
 
Configure forums access, groups, etc.
  
==Ratings==
+
===Ratings===
 
How ratings are calculated, who can rate, etc.
 
How ratings are calculated, who can rate, etc.
  
==Tags==
+
===Tags===
 
Edit tag aliases, reserve tags, counts, etc.
 
Edit tag aliases, reserve tags, counts, etc.
  
==Default User Avatar==
+
===Default User Avatar===
 
Upload a default avatar for new users
 
Upload a default avatar for new users
  
==Super Users==
+
===Super Users===
 
Edit list of super users
 
Edit list of super users
  
==Restrict Access==
+
===Restrict Access===
 
Restrict access to commands
 
Restrict access to commands
  
==Language==
+
===Language===
 
Configure Language use
 
Configure Language use
  
==Upload Throttles==
+
===Upload Throttles===
 
Limit the number and types of uploads per user
 
Limit the number and types of uploads per user
  
==Activity Log==
+
===Activity Log===
 
Configure the administrator's activity log
 
Configure the administrator's activity log
  
==Import Files==
+
===Import Files===
 
Import files from your server into ccHost
 
Import files from your server into ccHost
  
==Disable Site==
+
===Disable Site===
 
Disable site when doing maintainence.
 
Disable site when doing maintainence.
  
==Email==
+
===Email===
 
Configure system email address and access
 
Configure system email address and access
  
==Create Contest==
+
===Create Contest===
 
Create a new contest, set its start time, rules, etc.
 
Create a new contest, set its start time, rules, etc.
  
==Download Manager==
+
===Download Manager===
 
Count, checksum and license options for downloading
 
Count, checksum and license options for downloading
  
==Moderation/Flagging==
+
===Moderation/Flagging===
 
Configure moderation (Ban) and upload flagging
 
Configure moderation (Ban) and upload flagging
  
==Playlists==
+
===Playlists===
 
Manage Playlists
 
Manage Playlists
  
==Pseudo Verify==
+
===Pseudo Verify===
 
Configure usage of exotic and other dangerous file types
 
Configure usage of exotic and other dangerous file types
  
==Quota==
+
===Quota===
 
Configure user quota
 
Configure user quota
  
==Virtual ccHost==
+
===Virtual ccHost===
 
Create a new virtual root
 
Create a new virtual root
  
==Query Browser==
+
===Query Browser===
 
Configure query browser
 
Configure query browser
  
==Channels Page==
+
===Channels Page===
 
Configure playlists for the channels page
 
Configure playlists for the channels page
  
==Sample Pools==
+
===Sample Pools===
 
Managing sample pools and trackbacks
 
Managing sample pools and trackbacks

Revision as of 18:07, 7 July 2008

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

Introduction

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

Administrative Settings

Manage Site

Settings

Admins, editors, etc.

Skin

Choose a skin, theme, layout, colors, fonts, etc.

Navigator Tab Sets

Create and edit navigator tabs

File Formats

Pick which file formats are allowed to be uploaded

License

Pick which licenses a user is allowed to select from

Upload Renaming

Configure how uploads are automatically renamed

Submit Forms

Edit what kind of submit forms the user can see

Edit what the banner and footer says on each page.

Sidebar Extras

Pick what features are available on the side bar.

Menus

Edit the menus

ID3 Tagger

Configure how to tag ID3 compatible files (e.g. MP3s)

Menu Groups

Edit the menu groups

Thumbnails

Configure thumbnails handling (for image uploads)

Global Settings

Admin Help

Help on configuring the site

Global Setup

Cookies, ban message, admin email, 3rd party add ins, etc.

Manage Page Content

Manage special pages and topics

Paths

Configure where ccHost looks for stuff

Forum

Configure forums access, groups, etc.

Ratings

How ratings are calculated, who can rate, etc.

Tags

Edit tag aliases, reserve tags, counts, etc.

Default User Avatar

Upload a default avatar for new users

Super Users

Edit list of super users

Restrict Access

Restrict access to commands

Language

Configure Language use

Upload Throttles

Limit the number and types of uploads per user

Activity Log

Configure the administrator's activity log

Import Files

Import files from your server into ccHost

Disable Site

Disable site when doing maintainence.

Email

Configure system email address and access

Create Contest

Create a new contest, set its start time, rules, etc.

Download Manager

Count, checksum and license options for downloading

Moderation/Flagging

Configure moderation (Ban) and upload flagging

Playlists

Manage Playlists

Pseudo Verify

Configure usage of exotic and other dangerous file types

Quota

Configure user quota

Virtual ccHost

Create a new virtual root

Query Browser

Configure query browser

Channels Page

Configure playlists for the channels page

Sample Pools

Managing sample pools and trackbacks