/usr/share/doc/rest2web/html/force_mode.html is in rest2web-doc 0.5.2~alpha+svn-r248-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Building Websites the Easy Way</title>
<link rel="stylesheet" href="stylesheets/rest2web.css" type="text/css" />
<link rel="stylesheet" href="stylesheets/voidspace_docutils2.css" type="text/css" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="rest2web - build websites with Python and docutils." />
<meta name="author" content="Michael Foord" />
<meta name="copyright" content="© 2003-2006 Michael Foord, subject to BSD License" />
<meta name="keywords" content="rest2web - build websites with Python and docutils,
rest, restructured text, text, website, internet, web, net, web builder, site,
site builder, docutils, i18n, internationalization, templates, templating,
python, website, force, automatic, quick, shortcut" />
</head>
<body style="background: url(images/logos/img_background.gif) top center repeat-y;">
<div id="wrap">
<div id="header-section">
<a href="http://www.voidspace.org.uk/python/index.shtml" title="Voidspace"><img src="images/logos/header760.gif" alt="Voidspace"/></a>
<p align="center" class="headertitle"><span style="font-size:130%">rest2web:</span> Building Websites Across the Known Universe</p>
</div>
<div id="header">
<ul>
<li><a href="index.html">rest2web</a></li>
<li>></li>
<li>Force Mode</li>
</ul>
</div>
<table>
<tr>
<td><img src="images/logos/1.gif" width="1" height="1" alt="" /></td>
<!-- main content cell first, with rowspan=2 -->
<td valign="top" align="left" rowspan="2">
<div id="middle-column">
<a name="startcontent" id="startcontent"></a>
<div id="gallery">
<div class="document" id="building-websites-the-easy-way">
<h1 class="title">Building Websites the Easy Way</h1>
<h2 class="subtitle" id="the-force-mode">The Force Mode</h2>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#introduction" id="id1">Introduction</a></li>
<li><a class="reference internal" href="#using-force-mode" id="id2">Using Force Mode</a></li>
<li><a class="reference internal" href="#force-mode-and-config-file" id="id3">Force Mode and Config File</a></li>
</ul>
</div>
<div class="section" id="introduction">
<h1><a class="toc-backref" href="#id1">Introduction</a></h1>
<p>Sometimes you just want to throw some ReST documents together as HTML. Or
perhaps you need to keep your documents in normal ReST syntax, and you don't
want to add a <tt class="docutils literal"><span class="pre">restindex</span></tt>.</p>
<p>In this case, you want the <em>force mode</em>. <img src="images/smilies/smile.gif" alt="Smile" /> </p>
<p>In essence the force mode makes templates, restindexes and index pages
optional. It does this by supplying defaults where they are missing.</p>
<p>The default template (complete with sidebar) and default index page are stored
in the <tt class="docutils literal"><span class="pre">rest2web/defaults/</span></tt> directory. You are of course free to edit them.</p>
<div class="note">
<p class="first admonition-title">Note</p>
<p>This functionality is new, and needs to mature. For example, at the moment
you will probably want to edit the supplied defaults.</p>
<p>An obvious feature to add would be to allow the overriding of the defaults
at the command line.</p>
<p class="last">If you have any opinions about how this feature should develop, then please
comment on the <a class="reference external" href="http://lists.sourceforge.net/lists/listinfo/rest2web-develop">rest2web-develop mailing list</a>.</p>
</div>
<p>Files in your site can still be contained in a directory tree. rest2web will
create an index page for each directory, and link between them via the index
pages, sidebar and breadcrumbs.</p>
</div>
<div class="section" id="using-force-mode">
<h1><a class="toc-backref" href="#id2">Using Force Mode</a></h1>
<p>You activate force mode through the command line, with either the <tt class="docutils literal"><span class="pre">-f</span></tt> or
<tt class="docutils literal"><span class="pre">--force</span></tt> option.</p>
<p>When force is on and no template is specified, then the default one
(<tt class="docutils literal"><span class="pre">restweb/defaults/template.txt</span></tt>) is used.</p>
<p>If a template is specified in the restindex of any index page, then that will
be used for that directory (and all subdirectories) in the usual way.</p>
<p>Every directory that has no <tt class="docutils literal"><span class="pre">index.txt</span></tt> will use the default one.
(<tt class="docutils literal"><span class="pre">restweb/defaults/index.txt</span></tt>)</p>
<p>Every text file without a restindex will be assumed to be in ReST format. It
will use the normal defaults for a restindex.</p>
<p>The index page for the top level will have the title <em>Index for Site</em>.</p>
<p>Other index pages will have <em>Site</em> replaced with the directory name.</p>
<p>The page title will be used as the crumb and link-title for all pages.</p>
</div>
<div class="section" id="force-mode-and-config-file">
<h1><a class="toc-backref" href="#id3">Force Mode and Config File</a></h1>
<p>If you are in force mode, the config file is also optional.</p>
<p>In this case, the current directory is used as the source directory.</p>
<p>The output is put into a subdirectory called 'html'. This directory will be created if it doesn't exist, it will also not be scanned for source text files.</p>
</div>
</div>
</div>
<div id="end">
<p><a href="#startcontent">Return to Top</a><br />
<small>Part of the <a href="http://www.voidspace.org.uk/python/rest2web/">rest2web Docs</a></small><br />
<small>Page last modified <strong>Wed Oct 11 23:58:32 2006</strong>.</small>
</p>
</div>
</div></td>
</tr>
<tr>
<td valign="top" align="left" width="25%">
<div id="left-column">
<div id="sidie">
<ul>
<li class="left-navheader-first">
<a href="index.html" class="left-navheader">Index Page</a>
</li>
<li class="left-navheader">Pages</li>
<li><a href="introduction.html">Introduction</a></li>
<li><a href="quickstart.html">Quickstart</a></li>
<li><a href="config_file.html">Config File</a></li>
<li><a href="tutorial.html">Tutorial</a></li>
<li><a href="command_line.html">Command Line</a></li>
<li><a href="force_mode.html">Force Mode</a></li>
<li><a href="templating.html">Templates</a></li>
<li><a href="restindex.html">restindex</a></li>
<li><a href="functions.html">Functions</a></li>
<li><a href="macros.html">Macros</a></li>
<li><a href="special_files.html">Special Files</a></li>
<li class="left-navheader">Sub Sections</li>
<li><a href="reference/index.html">Reference</a></li>
<li><a href="test_site/index.html">Test Site</a></li>
<li><a href="translation/index.html">Translation</a></li>
<li><a href="gallery_test/index.html">Gallery</a></li>
</ul>
</div>
<p class="sidieimg">
<a href="http://www.python.org">
<img src="images/logos/new_python.gif" width="88"
height="103" border="0" alt="Powered by Python" />
</a>
</p>
<p class="sidieimg">
<a href="http://sourceforge.net/donate/index.php?group_id=138579">
<img src="http://images.sourceforge.net/images/project-support.jpg" width="100"
height="32" border="0" alt="Support This Project" />
</a>
</p>
<p class="sidieimg">
<a href="http://www.voidspace.org.uk/python/rest2web/"><img
src="images/logos/rest2web140x62.gif" width="142" height="62"
alt="Site Built with rest2web" /></a><br />
</p>
</div>
</td>
</tr>
</table>
<hr />
<p class="sidieimg">
<a href="http://www.voidspace.org.uk/python/rest2web/"><img src="images/logos/rest2web200x80.gif" width="200" height="80" alt="Site Built with rest2web" /></a>
<a href="http://sourceforge.net"><img src="http://sourceforge.net/sflogo.php?group_id=138579&type=5" width="210" height="62" alt="SourceForge.net Logo" /></a>
<a href="http://www.opensource.org"><img src="images/logos/osi-certified-120x100.gif" width="120" height="100" alt="Certified Open Source" border="1" /></a>
</p>
<p class="sidieimg">
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
</script>
<script type="text/javascript">
_uacct = "UA-203625-1";
urchinTracker();
</script>
</p>
<p class="sidieimg">
<a href="http://www.voidspace.org.uk/python/index.shtml"><img
src="images/logos/pythonbanner.gif" width="468" height="60"
alt="Python on Voidspace" /></a>
</p>
<div id="footer">
Copyright © Voidspace<br />Design by <a href="http://www.fuchsiashockz.co.uk">Fuchsiashockz</a> | <a href="http://validator.w3.org/check?uri=referer" title="Validate code as W3C XHTML 1.1 Strict Compliant">W3C XHTML 1.1</a> | <a href="http://jigsaw.w3.org/css-validator/check?uri=referer" title="Validate Style Sheet as W3C CSS 2.0 Compliant">W3C CSS 2.0</a>
</div>
</div>
</body>
</html>
|