Module z_path

Defines all paths for files and directories of a site.

Copyright 2009-2014 Marc Worrell

Authors: Marc Worrell (marc@worrell.nl).

Description

Defines all paths for files and directories of a site.

Function Index

abspath/2Return the absolute path to a file in the 'file' directory.
files_subdir/2Return the path to a files subdirectory.
files_subdir_ensure/2Return the path to a files subdirectory and ensure that the directory is present.
media_archive/1Return the path to the media archive directory.
media_preview/1Return the path to the media preview directory.
module_dir/2Return the path to the given module in the given context.
site_dir/1Return the path to the site folder of the given context.
user_modules_dir/0The directory of the user-defined modules.
user_sites_dir/0The directory of the user-defined sites.

Function Details

abspath/2

abspath(Path, Context) -> any()

Return the absolute path to a file in the 'file' directory

files_subdir/2

files_subdir(SubDir::filename(), Context::#context{}) -> filename()

Return the path to a files subdirectory

files_subdir_ensure/2

files_subdir_ensure(SubDir::filename(), Context::#context{}) -> filename()

Return the path to a files subdirectory and ensure that the directory is present

media_archive/1

media_archive(Context::#context{}) -> filename()

Return the path to the media archive directory

media_preview/1

media_preview(Context::#context{}) -> filename()

Return the path to the media preview directory

module_dir/2

module_dir(Module::atom(), Context::#context{}) -> string()

Return the path to the given module in the given context.

site_dir/1

site_dir(Context::#context{}) -> filename()

Return the path to the site folder of the given context.

user_modules_dir/0

user_modules_dir() -> any()

The directory of the user-defined modules

user_sites_dir/0

user_sites_dir() -> any()

The directory of the user-defined sites


Generated by EDoc, Sep 2 2014, 15:01:17.