Getting started
Most of the time spent in the Content Editor will be under the
Files tab. Here is where you edit and enhance the site.
The tab consists of two major parts; a row of buttons to the left and
the file system to the right, see pictures below.
File system
SiteBuilder stores all files in a version control repository which
does not correspond to any file system on your computer. However, this
does not make the file system much different from other file
systems. The buttons on the left side are used to perform tasks on the
directories or files in the file system.
The file system
Focusing
Focusing on a file or directory is done by clicking on its icon or
name. Focusing on a file will show information about the file and
allows for work on that file. Focusing on a directory shows a file
listing of that directory and allows actions that can be performed on
that directory. By clicking on the arrow to the left of a directory it
is possible to view a directory listing of that directory without
focusing on it.
Each file in the directory listings are listed with an icon
representing its file type, zero, one or two icons representing the
version control status of the file, the file name, the size of the
file and finally the file's title. The version control icons are
explained further in the Version control
chapter. The title of the file is fetched from its meta data.
File types
The type of a file is stored in its meta data. The file type controls
how it will be handled by SiteBuilder. A Word document will be handled
differently than an image or a HTML file. The file type determines
which editor to use when editing the file, how to upload and download
the file as well as how the version control system will handle it. It
is important that the file type is correct, otherwise it will be
impossible for SiteBuilder to handle it correctly.
The file type is related to the file extension, the part of file
name after the dot. SiteBuilder does not use the file extension
internally, it uses the meta data instead. But when interacting with
other systems the file extension will be used as a hint. When
uploading a file with a .doc extension SiteBuilder will
guess it is a Word file. In case the guess is wrong the user has
opportunity to correct it.
Buttons
The
buttons
As shown in the picture above, some buttons are grayed out, which
means that that function is not available for the current file or
directory. The buttons are context sensitive, the user's access
control permissions, the version control status as well as file type
determines whether a button will be grayed out or not. For instance,
if the user focuses on a directory in which she is not allowed to
change anything, most buttons will be grayed out.
The buttons are ordered in groups according to their area of use:
View
- View
-
Views the file, in another window.
- View source
-
Views the source of a file, in another
window.
- Log
-
Shows the version control log of the file
or directory.
- Annotate
-
Shows the source of the file with
annotations about when each line was changed by whom.
Log and annotate are discussed thoroughly in the Version
Control chapter.
Edit
- Edit/Edit new file
-
For a file this button launches the
chosen editor for that file type. For a directory it first creates a
new file, then launches the editor.
- Edit meta data
-
Editor for the meta data of the file,
such as its file type, the language it is written in and the template it
will use.
- Download file
-
Download a copy of the file to the
local file system for off-line editing.
- Upload file/Upload new file
-
For a file this button
is used to uploading a local copy of that file. For a directory a new
file will be created from the local file system.
File
- Create directory
-
Creates a new directory.
- Delete
-
Deletes this file or directory. For files the
file will only be deleted in this user's edit area. For directories
the directory, together with all files and subdirectories, will be
deleted.
- Copy
-
Copies a file or directory to another location.
- Move
-
Renames a file or directory or moves it to
another location.
Version control
- Discard your changes
-
Removes any changes made to the
file(s) from the user's edit area.
- Update
-
Updates the file(s) in the user's edit area
with the latest version(s) from the repository.
- Commit
-
Commits the file(s) from the user's edit area
to the repository.
- Join
-
Joins file(s) in two different work areas.
Access control
- Add protection point
-
Adds a protection point for this
file or directory.
- Remove protection point
-
Removes an existing
protection point for this file or directory.
Undelete
- Enter undelete mode
-
Enters the undelete mode where
removed files can be undeleted. Undelete mode is represented by a
different background color than normal in the file system and only a
few of the function buttons will be available. The background color in
undelete mode is pinkish by default.
- Undelete
-
Undeletes the file or directory.
|