Mason-CM Info   User: guest | Date: 10/22/2017 
OVERVIEW   DOCUMENTATION   MANUAL 
  Help:  User Manual

User Manual Mason-CM (V 1.2)



Overview

Mason Content Management (MCM or Mason-CM) is essentially a web-based file manager, making is easy for users to browse, edit and trigger files from staging to production.

You can click your way down directory levels; enter file or directory paths directly; or execute powerful recursive searches by file name or file contents.

Viewers are included for examining text files, images and binaries. The later only offers downlaod, to view the file localy on your desktop with the appropriate file editor. The editing and vewing screens remember your favorite screen dimensions. While editing a text, html, Mason component files files are locked during editing; others attempting to edit the same file receive a "file in use" error). When saving Mason components, the Content Management editor alerts you to any compile errors. The MCM editor also includes an HTML-friendly spell checker.

If you have a dedicated FTP upload area separate from your staging areas, a file-transfer utility is included for copying files into staging. When you're ready to "go live", content and component files can be triggered (copied, from staging to production) from within MCM.

If version control is enabled, changes to each file are logged in a version history; past versions of a file can be viewed or retrieved at any time.

Starting a Content Management Session

Once you authenticate yourself with your login ID and password, Content Management greets you with its index page:

Note the Branch Selector on the right. Each branch represents a different filesystem under Content Management; click another branch and note how the directory and file listings change. Keeping track of the current branch is important since all navigation and searching is restricted to the currently selected branch. The branches shown in the branch selector can be customized via the [PROFILE] profile page (link at upper right).

Most of the items on the index page are clickable: click on directories to navigate into them; click on file names to view files; click on the pieces of the current directory to return to higher levels. You can sort by columns in the file listing by clicking the column headers. The rightmost "status" column displays one of "prod", "staging", or "modified" for each file:

  • modified - staging file is more recent than production; hit the link to view a difference report
  • prod - production copy of file is up-to-date (file has been triggered)
  • staging - file exists only in the staging area

Hint: Sorting on the "status" column groups all of your recently-modified files for easy triggering.

The [GOTO] and [SEARCH] fields at the top of the page let you navigate by typing a file or directory path, or searching by filename or file contents (searches are recursive from the current directory down). Buttons at the bottom of the page let you trigger or delete any tagged files.

Mr. Juggler, in the upper left, also appears in later MCM sub-screens; he serves to escort you back to the last index page you were viewing.

Navigation

The simplest type of navigation in Content Management is point-and-click. All subdirectory and file names are linked: click a file name to view a file, click a subdirectory to navigate into it. You can also navigate by clicking any portion of the "Current directory" path. If you have write-access to a directory, [EDIT] links will also appear next to each file--these activate the Content Management file editor (discussed later in Other File Operations).

You can also navigate directly to a file or directory by typing a path into the [GOTO] field. Absolute paths (starting with a "/") or relative paths may be given. These work, respectively, from the root of the current branch or from the current directory. Here are some examples, assuming the current directory is "Content/tw/stories":

  • "111398.html" navigates to file "Content/tw/stories/111398.html"
  • "/111398.html" navigates to file "Content/111398.html"
  • ".." navigates to directory "Content/tw"

Searching

Perhaps you've forgotten where you saved that "foo" file? Or you can't recall which component had that slick cookie-management code? Don't despair: Content Management can help by searching for files based on filename or content. Simply type a search string into the "Search" box and hit Return.

Shown here is a simple file name search; to perform content or case-insensitive searches, activate the appropriate checkboxes. Both search types are recursive, i.e. they descend into subdirectories looking for matches.

The "Search for" link brings up a help page listing common searches; for the ambitious there's even a primer on advanced searching with Perl regular expressions.

Uploading Files From FTP Area

Files are easily copied from FTP upload directories to the staging area from within Content Management.

  1. On the index page, navigate to the directory you wish to copy files to.
  2. Click on [FTP Exchange] at Functions, at the right side of the index page.
  3. Navigate to the FTP directory you wish to copy from.
  4. Highlight one or more files from the ftp area and click the arrow button [>>>] to copy files to staging.
  5. Click Mr. Juggler to return to the index page.

User and File Security

To prevent multiple users from editing the same file, Content Management locks each file at the start of an editing session. If you try to edit a file in use by someone else, Content Management issues a warning like this:

To release a file that you've been editing, you must hit one of [CANCEL] or [CHECKIN] from the editing screen. If you leave the editing screen by another route (click [<< GO BACK TO LIST], close your browser or follow a bookmark), you will be reminded of any pending locks the next time you return to the index page:

From this list you can return to the editor by clicking a file name, or hit "release the file" to release immediately.

Creating and Deleting Files

To create a new text file in the current directory, click Functions [New File]. The in the apeared function form simply enter a filename field and click [CREATE FILE].

MCM creates the file in the current directory, ready to be edited (see Other File Operations below for a description of the Content Management file editor).

File are deleted from the index page by selecting the ones you want to delete and hit the [DELETE] button at the bottom of the page (note the Check all shortcut). If you accidentally delete the wrong file or files, it may be possible to restore them from backups; contact the MCM Admin for help.

Creating and Deleting Directories

Subdirectories are created just like files: simply type in a new directory name in the directory "create" field and hit Return (or the "create" button).

To delete a directory, you must first empty it of all files and subdirectories. At that point Content Management replaces the "Trigger" and "Delete" buttons at the bottom of the page with a "Delete the current, empty directory" button.

Other File Operations: Viewing, Editing, Copying, Renaming

If you've been reading this document straight through (bless your heart), you've probably clicked on a file name or two and discovered that Content Management has viewers for text image and binray files:

To checkout a component or content file for editing, click the [EDIT] link next to the file name. This brings you to the Content Manager edit screen:

The first thing you'll want to do on the edit screen (the viewers as well, actually) is jump to the bottom and set the dimensions of the text window to match your browser. Most current browsers (like Netscape) can record these setting in a cookie; older browsers may forget your dimensions when you leave the edit screen.

At the top of the editing screen, a number of buttons and fields perform operations on the current file:

[SAVE]

Save changes without leaving the edit screen.

[RENDER]

Save and unlock the file, then jump to the viewer in "render" mode.

[CLOSE]

Save the file, then return to the index page. Keep the file locked.

[CHECKIN]

Save and unlock the file, then return to the index page.

[CANCEL]

Cancel changes and unlock the file, then return to the index page.

comment a new version

If entered, instructs Content Management to record these changes in the version history (see Version History for details).

spell language

If a language is selected go first to spell check without saving, but of course keeping the content.

The next three buttons you get from the Functions menu. Be sure save any changes to a file before clicking the button!

[COPY FILE] To make a copy of the current file, type a destination into the copy/rename field and hit Return or the "Copy" button. Like the [GOTO] field on the index page, you can enter a relative or absolute file or directory name here. For example:
  • ".." copy this file to the parent directory
  • "foo.bak" copy to a new file named foo.bak (in the current directory)

Be sure save any changes to a file before you copy it!

[MOVE FILE]

To rename a file, simply type in a new file name and hit Return or the "Rename" button. Since image files aren't editable, copy and rename functions are available in the image viewer .

Be sure save any changes to a file before you copy it!

[UPLOAD CONTENT]

Uploads text from your desktop (f.i. HTML snipplet, changed file). Choose if you want to append or replace the existing text.

 

Spell Checking

The Content Management editor features an integrated spell checking feature that:

  • understands HTML tags
  • offers word suggestions through pop-up windows
  • lets you add words to a customizable personal dictionary
To use the spell checker:
  1. Select in spell language dropdown on the editing screen a language, then hit any of the [SAVE] buttons (SAVE, RENDER,CLOSE,CHECKIN)).
  2. Next, a spell check screen appears in which misspelled words are shown in text fields with adjacent [?] and [ADD] buttons. The [?] button will pop up a suggestion box with alternative spellings, while the [ADD] button adds this word to the dictionary. You can also simply edit the word in the text field.
  3. When you've finished checking the document, hit [DONE] and Content Management will complete the save operation you had originally requested. [CANCEL] cancels the spell check, NOT the save operation in progress.

A note about adding words to the dictionary: the dictionary is personal to the user, anyhow be careful when adding words. If you find a misspelled word that's NOT being caught by the spell checker, and you think that's a really normal word, please send it to MCM Admin.

Limitations on HTML characters: be aware the you can not use HTML substitutions for ä, ü, è, à, ô like &auml;, &uuml;,&egrave;, &agrave;, &ocirc; because MCM does not touch these substitutions.

Triggering

A primary function of Content Management is triggering files from the development, or staging area to the "live", or production site.

A handy trick (mentioned earlier) is to first sort by the status column to group your modified files. Description of the three buttons releated to triggering, "publishing".

[TRIGGER]

Triggering files is accomplished much the same way as deleting them: check the files you want to trigger (from the index page), then hit the button at the bottom.

[REVERSE TRIGGER]

Occasionally you may need to undo changes to a staging file. To be on the safe side, you will need to confirm that you really want to overwrite files on staging.

[WITHDRAW]

Means just deleting from production area, but keeps the staging area unchanged. To be on the safe side, you will need to confirm that you really want to withdrwa files from production area.

 

Advanced Features

This section is intended for more advanced users familiar with operating systems, searching techniques, and Mason components.

Searching

Both filename and content searches can be extended with regular expression syntax (several examples are shown in the "Search for" help screen), letting you compose powerful and detailed search expressions.

Let's start with a simple example of filename searching: type an "e" into the search field and hit Enter. MCM responds with a list of files containing an "e" anywhere in their name. Slightly fancier is "^e", which matches all filenames that start with an "e". Fancier still is "^..e", matching all filenames with "e" as the third character (some regexp stuff to demystify all this: "^" matches from the beginning, while "." matches any single character).

Note that case-sensitivity is turned off by default for both types of searches (filename and content).

Content searching is helpful when you know what's in a file but not it's name (Unix hacks, think of a recursive grep). Like filename searches, content searches are recursive and case-sensitive by default. Also keep in mind that simpler searches are quicker then more complex ones. A search for "Elvis" (the character sequence "Elvis") will be faster than a regular expression like "\bElvis\b" (the word "Elvis") or "Elvis|King" (matches "Elvis" or "King").

See also: Regular Expressions

Special features for components

When editing a brand-new Mason component with the editor you'll see some boilerplate comments -- feel free to embellish these!

During save or trigger operations, components are checked for Mason compile errors, exept ignore compile errors? is checked. Those with errors can either be edited to fix the errors or saved with errors intact (data files, for instance, that happen to reside in a component directory). When triggering components, if one or more of the components contain errors, MCM doesn't revert to the index page, but instead offers some options for dealing with the errors:

Sick components are linked back to the edit page, in which you can immediately view the compile error. Normally at this point you would debug the component in the editor until you get a clean save.

In some cases, however, you may want to trigger files to production with errors intact (non-component data files, for instance). In this case you simply check the files you want to force into production and hit the [FORCE TRIGGER] button.

When working with components in the editor, Content Management checks for Mason compile errors with each save operation. Unless the "ignore compile errors" option is checked, compile errors display at the top of the editor, and hold you back from returning to the index page:


see also:
Online Mason Manual learn everything on Mason syntax
Online Perl Documentation the standard perl.pod

 Manual

   

© 2007 Mason-CM V 1.3, Content Management built on Mason - Headquarter, CPAN