File: web_conventions.html

package info (click to toggle)
funnelweb-doc 3.2d-4.2
links: PTS
area: main
in suites: forky, sid, trixie
size: 3,744 kB
sloc: perl: 241; makefile: 23
file content (224 lines) | stat: -rw-r--r-- 7,634 bytes
parent folder | download | duplicates (5)

<HTML>
<!--
***********************************************************************
FUNNELWEB MANUAL WEB PAGE
=========================
Copyright (c) Ross N. Williams 1992,1999. All rights reserved.

Permission is granted to redistribute and use this manual in
any medium, with or without modification, provided that all
notices (including, without limitation, the copyright
notice, this permission notice, any record of modification,
and all legal notices) are preserved on all copies, that all
modifications are clearly marked, and that modified versions
are not represented as the original version unless all the
modifications since the manual's original release by Ross N.
Williams (www.ross.net) consist of translations or other
transformations that alter only the manual's form, not its
content. THIS MANUAL IS PROVIDED "AS IS" AND WITHOUT ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT
LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND
FITNESS FOR A PARTICULAR PURPOSE. TO THE EXTENT PERMITTED BY
LAW THERE IS ABSOLUTELY NO WARRANTY.

***********************************************************************
-->

<HEAD>
<TITLE>7.8 Hints And Conventions</TITLE>
<STYLE TYPE="text/css"> <!-- A {text-decoration: none} // --> </STYLE>
</HEAD>
<BODY BACKGROUND="binary/background.gif"
      BGCOLOR="#FFFFFF"
      TEXT="#000000"
      VLINK="#660000"
      LINK="#FF0000"
      ALINK="#CC0000">

<TABLE WIDTH="490">
<TR>
<TD WIDTH="130" VALIGN="top">
<IMG SRC="binary/d_clear.gif" ALT="" WIDTH="130" HEIGHT="1"><BR>

<FONT SIZE="2">
<BR>

<A HREF="http://www.ross.net/"
 TARGET="rosshome"
 onClick="window.open('','rosshome','location,status,menubar,scrollbars,resizable',false).focus(); return true;"
>
 <IMG SRC="binary/rossnet_logo.gif"
  WIDTH="64" HEIGHT="32"
  BORDER="0" ALT="RossNet"
  HSPACE="0" VSPACE="1"></A><BR>
<BR>

<A HREF="../index.shtml"
 TARGET="funnelweb"
 onClick="window.open('','funnelweb','location,status,menubar,scrollbars,resizable',false).focus(); return true;"
>
 <IMG SRC="binary/linklogo.gif"
  WIDTH="64" HEIGHT="32"
  BORDER="0" ALT="FunnelWeb"
  HSPACE="0" VSPACE="1"></A><BR>
<BR>
<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0><TR><TD BGCOLOR="#000000">
<A HREF="../reference/index.html"
 TARGET="funnelwebreference"
 onClick="window.open('','funnelwebreference','location,status,menubar,scrollbars,resizable',false).focus(); return true;"
><FONT COLOR="#FFFFFF"><B>Reference</B></FONT></A><BR>
<BR>
<A HREF="../developer/index.html"
 TARGET="funnelwebdeveloper"
 onClick="window.open('','funnelwebdeveloper','location,status,menubar,scrollbars,resizable',false).focus(); return true;"
><FONT COLOR="#FFFFFF"><B>Developer</B></FONT></A><BR>
<BR>
<A HREF="index.html"><FONT COLOR="#FFFFFF"><B>Tutorial</B></FONT></A><BR>
<A HREF="intro.html"><FONT COLOR="#FFFFFF">1 Introduction</FONT></A><BR>
<A HREF="macro.html"><FONT COLOR="#FFFFFF">2 Macros</FONT></A><BR>
<A HREF="type.html"><FONT COLOR="#FFFFFF">3 Typesetting</FONT></A><BR>
<A HREF="example.html"><FONT COLOR="#FFFFFF">4 Example</FONT></A><BR>
<A HREF="hints.html"><FONT COLOR="#FFFFFF">5 Hints</FONT></A><BR>
<A HREF="examples.html"><FONT COLOR="#FFFFFF">6 Examples</FONT></A><BR>
<A HREF="web.html"><FONT COLOR="#FFFFFF">7 Webmaking</FONT></A><BR>

<BR>
<A HREF="search.html"><FONT COLOR="#FFFFFF"><B>SEARCH</B></FONT></A><BR>
</FONT>
</TD></TR></TABLE>


</TD>
<TD WIDTH="360" VALIGN="top">
<FONT SIZE="3">


<A HREF="../reference/index.html"><IMG SRC="binary/title.gif"
 WIDTH="302" HEIGHT="24"
 BORDER="0" ALT="FunnelWeb Tutorial Manual"
 HSPACE="0" VSPACE="0"></A>
<P><FONT SIZE="5">7.8 Hints And Conventions</FONT><BR>


<P><BR><FONT SIZE="4"><STRONG>Where To Include Include Files</STRONG></FONT><BR>

<P>It's better to include your include files at the end of the
main web file, as if FunnelWeb generates an error, the line number
in the listing file is easier to correlate with the main file if
several files have not been included.

<P><BR><FONT SIZE="4"><STRONG>Separating Pages</STRONG></FONT><BR>

<P>It's a good idea to separate the macro for each page in a web
in the FunnelWeb file, by a line of asterisks in a FunnelWeb comment.
This makes the FunnelWeb source file easier to work on in your
text editor.

<P>
<PRE>
@!************************************************

@O@&lt;index.html@&gt;@{
@&lt;Begin page@&gt;@(Dave's Home Page@)

&lt;P&gt;Welcome to my home page. Check out my
&lt;A HREF="@&lt;Links FILE@&gt;"&gt;links page&lt;/A&gt;.

@&lt;End page@&gt;
@}

@!************************************************

@$@&lt;Links FILE@&gt;@M@{links.html@}
@O@&lt;links.html@&gt;@{
@&lt;Begin page@&gt;@(Dave's Links@)

&lt;P&gt;Check out @&lt;Yahoo@&gt; and @&lt;Dilbert@&gt;.

@&lt;End page@&gt;
@}

@!************************************************
</PRE>

<P><BR><FONT SIZE="4"><STRONG>Input And Output Line Lengths</STRONG></FONT><BR>

<P>When using FunnelWeb to create webs, you will probably find
that your input and output files have lines longer than the
FunnelWeb standard 80 characters. So you may wish to include the
following directives in your main and include files:

<P>
<PRE>
@p maximum_input_line_length = 200
@p maximum_output_line_length = 200
</PRE>

<P><BR><FONT SIZE="4"><STRONG>Macro Naming Conventions</STRONG></FONT><BR>

<P>Since 1994, I (<A HREF="http://www.ross.net/">Ross Williams</A>) have been using FunnelWeb to
generate all the webs in all my webspaces. During this time, I have
developed some macro naming conventions which you may wish to adopt.

<P><BLOCKQUOTE><B>FILE:</B> Use this suffix for macros that contain
                            the names of files that form part of the web.</BLOCKQUOTE>

<P><BLOCKQUOTE><B>WWW:</B> Use this suffix for macros that define
                           web directory URLs, up to and including the trailing slash.
                           The URL may be absolute or relative, depending on the context.</BLOCKQUOTE>

<P><BLOCKQUOTE><B>WWW/abs:</B> Use this suffix where the URL must
                               be absolute.</BLOCKQUOTE>

<P><BLOCKQUOTE><B>EMAIL:</B> Use this suffix for email addresses.</BLOCKQUOTE>

<P><BLOCKQUOTE><B>FTP:</B> Use this suffix for FTP directory addresses.</BLOCKQUOTE>

<P><BLOCKQUOTE><B>WINDOWNAME:</B> Use this suffix for the names of
                                  browser windows.</BLOCKQUOTE>

<P>Here are some examples:

<P>
<PRE>
@$@&lt;Home FILE@&gt;@Z@M@{index.html@}
@$@&lt;Ross WWW@&gt;@Z@M@{http://www.ross.net/@}
@$@&lt;Ross WWW/abs@&gt;@Z@M@{http://www.ross.net/@}
@$@&lt;Ross EMAIL@&gt;@Z@M@{ross@ross.net@}
@$@&lt;Ross FTP@&gt;@Z@M@{@-
ftp://www.ross.net/clients/ross/@}
@$@&lt;Ross WINDOWNAME@&gt;@Z@M@{ross@}
</PRE>


<P>
<TABLE WIDTH="100%">
<TR>
<TD ALIGN="left"   VALIGN="bottom"><A HREF="web_param.html"><IMG SRC="binary/fw_left.gif" HEIGHT="32" WIDTH="32" BORDER="0" ALT="Prev"></A></TD>
<TD ALIGN="center" VALIGN="bottom"><A HREF="web.html"><IMG SRC="binary/fw_up.gif" HEIGHT="32" WIDTH="32" BORDER="0" ALT="Up"></A></TD>
<TD ALIGN="right"  VALIGN="bottom"><A HREF="web.html"><IMG SRC="binary/fw_up.gif" HEIGHT="32" WIDTH="32" BORDER="0" ALT="Up"></A></TD>
</TR>
</TABLE>



<HR>
<FONT SIZE="2">
<A HREF="mailto:webmaster@ross.net">Webmaster</A>&nbsp;&nbsp;&nbsp;
<A HREF="copyright.html">Copyright &copy; Ross N. Williams 1992,1999. All rights reserved.</A><BR>
</FONT>

</FONT>
</TD>
</TR>
</TABLE>


</BODY>

<!-- *********************************************************************** -->
<!--      End Of A FunnelWeb Manual Web Page (www.ross.net/funnelweb/)       -->
<!-- *********************************************************************** -->

</HTML>