[Rt-commit] rt branch, 4.0/add-styling-rt-docs, created. rt-4.0.8-216-ga247e7a

[Thomas Sibley]

On 12/07/2012 02:01 PM, Jim Brandt wrote:
> +=head1 RT Theme Editor
> +
> +RT has some built-in controls to manage the look of the theme you select.
> +To use the Theme Editor, log in as a SuperUser (like root), and navigate
> +to Tools > Configuration > Tools > Theme.
> +
> +=for html <img alt="RT theme editor, defaults" src="images/theme_editor_defaults.png">
> +
> +=for :text [RT theme editor image at F<http://bestpractical.com/rt/docs/images/theme_editor_defaults.png>]

The =for :man section is missing, which is what's used for perldoc.

Additionally, the F<URL> is wrong.  F<> is for filenames, not URLs.  For
the text and man formatters, it doesn't make sense to refer to a URL as
they're looking at the doc locally.  It should just refer to
F<docs/images/theme_editor_defaults.png>.

Otherwise the doc seems fine.