REMARK Documentation

Configuring Remark

Global configuration

at the root of the remark installation, you will see a file called config.r

This file needs the following to be included:

sites: [%docs/]

tags:  [%tags/]

sites:

This value sets where you want remark to look for site configuration files.

tags:

This tells remark where to look for global sets of tags you wish all sites to have access to.

These become default tags, note that directories are supported, in which case remark attemps to load ALL .rtag, .htag, .ttag file it finds

Site configuration

This file setups up each site and can be used to add or even replace the rtags within the default setup.

This file needs the following to be included:

label: "REMARK DOCS"

  source: [%source/] 

  destination: [%html/]

  tags: [%tags/]
  
  valid-file-types: [ "html" "htm" "css" "png" "jpg" "gif" "rsp"]
  
  html-file-types: [ "html" "htm" "rsp"]
  
  ftp-url: ftp://user:passwd@domain.com/site/root

label:

simply the name you want this site to have within the remark ui

source:

Where does this site take its source files from... This is the site root and is relative to the site config.r file itself, or can be absolute.

If using absolute paths, you can actually define multiple sites which use the same source dirs but different tag sets.

In this case, you can publish several different versions, looks, or layouts of the same site with no effort.

You can also load files from more than one source dir and merge sites!

destination:

Logical complement to the source option. This will determine where to dump the parsed files.

Each root destination is a copy of the site.

tags:

This tells remark where look for site specific tags (either rtags, htags or ttags).

Any tag loaded from this path will overide the global tag if a naming conflict occurs internally. This is a cool feature allowing you to change default behaviour of any standard tags.

valid-file-types:

A list of file extensions you wish to copy from the source to the destination... all other files will be ignored.

test

html-file-types:

List of file extensions you want remark to parse.

All other valid files are simply binary copied over to the destination, within a matching subdirectory.

ftp-url:

**optional**

Tells remark that you have an ftp access to your site. ftp-url is optional, but when set, will add a row of buttons which allow you to list, dump and delete the content of a site, remotely.

Its not very smart, as is copies/lists/delete the whole site all the time, but at least, its hands off. and recursive... so you edit your site and when you are done, you just dump the site once. (you might want to delete the remote site first, if you want to make sure you don't leave garbage pages or files on the server, which are not being used any more.




last updated: 21-Feb-2007/13:36:13-5:00