docs.roxen.comBack to normal mode
DocsRoxen2.1Web Site Creator ManualEmit Tags
Copyright © 2001, Roxen Internet Software
Suggestions, comments & compliments
manuals@roxen.com

<emit source="dir"></emit>

Provided by module: Dir emit source

This plugin is used to generate directory listings. The directory module must be added to use these entities. This plugin is only available in the directory template.


Attributes

directory="path"

Apply the listing to this directory.


options="(real-file,thumbnail,imagesize)"

Use these options to customize the directory listings. These argument have been made options due to them demanding a lot of raw computing power, since they involve image manipulation and other demanding tasks. These options can be combined.

real-file

Makes it possible to show the absolute location of the file including the filename from an 'outside Roxen' view.

thumbnail

Makes it possible to use image thumbnails in a directory listing. Note: Remember that some imageformats needs heavy computations to generate thumbnails. tiff for instance needs to unpack its image to be able to resolve the image's height and width.

imagesize

Makes it able to show the image's height and width in a directory listing. Note: Remember that some imageformats needs heavy computations to generate thumbnails. tiff for instance needs to unpack its image to be able to resolve the image's height and width.


thumbnail-size="number"

Sets the size of the thumbnail. Defaultsize is 60 pixels. The size is set in proportion to the image's longest side, e.g. if the height of the image is longer than it's width, then the thumbnail will be 60 pixels high. The shortest side will be shown in proportion to the longest side. This attribute can only be used together with the option="thumbnail" attribute.


thumbnail-format="imageformat"

Set the output format for the thumbnail. Default is png. All imageformats that <cimg> handles can be used to produce thumbnails. This attribute can only be used together with the option="thumbnail" attribute.


strftime="strftime string" (%Y-%m-%d)

Format the date according to this string. Default is the isotime format (%Y-%m-%d), which will return (Year(four characters)-month(two characters)-day(two characters)), e.g. 2000-11-22. See the attribute strftime in <date> for a full listing of available formats.


glob="glob-pattern1[,glob-pattern2,...]"

Only show files matching the glob-pattern.


type="glob-pattern1[,glob-pattern2,...]"

Only show files which content-type matches the glob-pattern.


sort-order="{alpha, dwim, modified, size, type}" (dwim)

Sort the files and directories by this method.

alpha

Sort files and directories alphabetically.

dwim

Sort files and directories by "Do What I (want) Method". In many methods numeriacal sorts fail as the number '10' often appears before '2'. This method sorts numerical characters first then alphabetically, e.g. 1foo.html, 2foo.html, 10foo.html, foo1.html, foo2.html, foo10.html.

modified

Sort files by modification date.

size

Sort files by size.

type

Sort files by content-type.


sort-reversed

Reverse the sort order.


&_.atime; (provided by Dir emit source)

Returns the date when the file was last accessed.


&_.atime-iso; (provided by Dir emit source)

Returns the date when the file was last accessed. Uses isotime (%Y-%m-%d).


&_.atime-unix; (provided by Dir emit source)

Returns the date when the file was last accessed. Uses unixtime.


&_.dirname; (provided by Dir emit source)

Returns the directoryname.


&_.filename; (provided by Dir emit source)

Returns the filename.


&_.filesize; (provided by Dir emit source)

Returns a file's size in bytes. Directories get the size "-2".


&_.mode; (provided by Dir emit source)

Returns file permission rights represented binary, e.g. "r-xr-xr-x".


&_.mode-int; (provided by Dir emit source)

Returns file permission rights represented by integers. When encoded to binary this represents what is shown when using the Unix command "ls -l" or as shown using &_.mode;, e.g. "16749".


&_.mtime; (provided by Dir emit source)

Returns the date when the file was last modified.


&_.mtime-iso; (provided by Dir emit source)

Returns the date when the file was last modified. Uses isotime (%Y-%m-%d).


&_.mtime-unix; (provided by Dir emit source)

Returns the date when the file was last modified. Uses unixtime.


&_.name; (provided by Dir emit source)

Returns the name of the file or directory.


&_.path; (provided by Dir emit source)

Returns the path to the file or directory.


&_.size; (provided by Dir emit source)

Returns a file's size in kb(kilobytes).


&_.thumbnail; (provided by Dir emit source)

Returns the image associated with the file's content-type or directory. Only available when option="thumbnail" is used.


&_.type; (provided by Dir emit source)

Returns the file's content-type.


&_.type-img; (provided by Dir emit source)

Returns the internal Roxen name of the icon representating the directory or the file's content-type, e.g. internal-gopher-menu for a directory-folder or internal-gopher-text for a HTML-file.


&_.x-size; (provided by Dir emit source)

Returns the width of the image. Only available when option="imagesize" is used.


&_.y-size; (provided by Dir emit source)

Returns the height of the image. Only available when option="imagesize" is used.