English Yacs handbook Authoring

How to manage options for articles?

The options field is a convenient place to save attributes for any article without extending the database schema.

Specific options to be processed by advanced overlays are not described hereafter.

You can combine any of following keywords in the field for options, with the separator (spaces, tabs, commas) of your choice:

[*] files_by_title - When wiewing articles, order attached files by alphabetical order instead of using edition time information. This option may prove useful to structure a list of files. For example, on a page describing a complex project, you would like to offer an introduction to the project ('1.introduction.doc'), then a report on initial issue ('2.the issue.ppt'), and a business case for the solution ('3.profit_and_loss.xls'). By adjusting file names and titles as shown, and by setting the option files_by_title, you would achieve a nice and logical thing.

[*] formatted - The YACS rendering engine is disabled, since the description contains formatting tags. Use this option if you copy the source of a HTML or of a XHTML page, and paste it into an article at your server. Note that this keyword is also accepted if it is formatted as a YACS code ('[formatted]') at the very beginning of the description field.

[*] hardcoded - The YACS rendering engine is disabled, except that new lines are changed to (X)HTML breaks. Use this option if you copy some raw text file (including a mail message) and make a page out of it. Note that this keyword is also accepted if it is formatted as a YACS code ('[hardcoded]') at the very beginning of the description field.

[*] links_by_title - When wiewing articles, order attached links by alphabetical order instead of using edition time information. This options works like files_by_title, except that it applies to link. Use it to create nice and ordered bookmarks.

[*] locked - The page cannot be modified (except by an associate), and related items (files, comments) are locked as well. This option may be used to end a thread in the forum, or to prevent others to contribute to one of your page.

[*] no_comments - New comments cannot be posted on this page.

[*] no_files - New files cannot be attached to this page.

[*] no_links - New links cannot be posted to this article.

[*] skin_<xxxx> - Select one skin explicitly. Use this option to apply a specific skin to a page. This setting is the most straightforward way of introducing some skin to web surfers.

[*] variant_<xxxx> - Select one skin variant explicitly. Usually only the variant 'articles' is used throughout articles. This can be changed to 'xxxx' by using the option variant_<xxxx>. Then the underlying skin may adapt to this code by looking at $context['skin_variant']. Basically, use variants to change the rendering of individual articles of your site, if the skin allows it.