Location: PHPKode > projects > PhpScribe Documentation Generator > templates/file.tpl
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
<HTML>
<HEAD>
{generated}
<TITLE>
{fileName} ({projectName})
</TITLE>
<META NAME="keywords" CONTENT="{fileName} file, {projectName}">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style">
</HEAD>
<SCRIPT>
function publishTitle()
{
parent.document.title="{fileName} ({projectName})";
}
</SCRIPT>
<BODY BGCOLOR="white" onload="publishTitle();">

<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../project_overview.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>File</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../project_tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../project_index.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../documentation.html"><FONT CLASS="NavBarFont1"><B>Docs</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>{projectName}</b></EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2" COLSPAN="3"><FONT SIZE="-2">
&nbsp;{prevFile}&nbsp;
&nbsp;{nextFile}</FONT></TD>
</TR>
<TR>
<TD VALIGN="top"><FONT SIZE="-2">
  SUMMARY:&nbsp;<A HREF="#constant_summary" CLASS="NavBarCell3">CONSTANT</A>&nbsp;|&nbsp;<A HREF="#function_summary" CLASS="NavBarCell3">FUNCTION</A></FONT></TD>
<TD VALIGN="top"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#constant_detail" CLASS="NavBarCell3">CONSTANT</A>&nbsp;|&nbsp;<A HREF="#function_detail" CLASS="NavBarCell3">FUNCTION</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>

<H2>
{fileName}</H2>
<P>

<DL>
 <DT>Name: <B>{fileName}</B>
 <DT>Type: {fileType}
</DL>

<HR>
<P>

<!-- START BLOCK : constant_summary -->
<A NAME="constant_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constant Summary</B></FONT></TD>
</TR>
<!-- START BLOCK : loop_constant_summary -->
<TR BGCOLOR="white" CLASS="TableRowColor">
 <TD>
  <CODE><B><A HREF="#constant_{constantName}">{constantName}</A></B></CODE>
  &nbsp;&nbsp;{constantDesc}
 </TD>
</TR>
<!-- END BLOCK : loop_constant_summary -->
</TABLE>
<P>
<!-- END BLOCK : constant_summary -->

<!-- START BLOCK : function_summary -->
<A NAME="function_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  <TD COLSPAN=2>
   <FONT SIZE="+2"><B>Function Summary</B></FONT>
  </TD>
 </TR>
 <!-- START BLOCK : loop_function_summary -->
 <TR BGCOLOR="white" CLASS="TableRowColor">
  <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
   <CODE>&nbsp;{functionReturnType}</CODE></FONT></TD>
  <TD><CODE><B><A HREF="#function_{functionName}"">{functionName}</A></B>({paramList})</CODE>
  <BR>
  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{functionDesc}</TD>
 </TR>
 <!-- END BLOCK : loop_function_summary -->
</TABLE>
<P>
<!-- END BLOCK : function_summary -->

<!-- START BLOCK : constant_detail -->
<A NAME="constant_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  <TD COLSPAN=1><FONT SIZE="+2">
   <B>Constant Detail</B></FONT>
  </TD>
 </TR>
</TABLE>
<!-- START BLOCK : loop_constant_detail -->
<A NAME="constant_{constantName}"><!-- --></A><H3>
{constantName}</H3>
<DL>
<DD>Value: {constantValue}
<DD>{constantDesc}
</DL>
<P ALIGN="left"><A HREF="#navbar_top">top</A>
<HR>
<!-- START BLOCK : loop_constant_detail -->
<P>
<!-- END BLOCK : constant_detail -->

<!-- START BLOCK : function_detail -->
<A NAME="function_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  <TD COLSPAN=1>
   <FONT SIZE="+2"><B>Function Detail</B></FONT>
  </TD>
 </TR>
</TABLE>
<!-- START BLOCK : loop_function_detail -->
<A NAME="function_{functionName}"><!-- --></A><H3>{functionName}</H3>
<PRE>function <B>{functionRef}{functionName}</B>({paramList})</PRE>
<DL>
<DD>{functionDesc}
<P>

<DD><DL>
<!-- START BLOCK : function_params -->
<DT><B>Parameters:</B>
<!-- START BLOCK : loop_function_params -->
<DD><CODE>{datatype} {paramName}</CODE> - {paramDesc}{paramDefault}
<!-- END BLOCK : loop_function_params -->
<!-- END BLOCK : function_params -->
<!-- START BLOCK : function_return -->
<DT><B>Returns:</B>
<DD>{functionReturnType}{functionReturn}
<!-- END BLOCK : function_return -->
<!-- START BLOCK : function_see -->
<DT><B>See Also:</B>
<DD>{seeList}
<!-- END BLOCK : function_see -->
<!-- START BLOCK : function_notes -->
<DT><B>Notes:</B>
<!-- START BLOCK : loop_function_notes -->
<DD>{noteDesc}
<!-- START BLOCK : loop_function_notes -->
<!-- END BLOCK : function_notes -->
<!-- START BLOCK : function_author -->
<DT><B>Written by:</B>
<DD>{functionAuthor}
<!-- END BLOCK : function_author -->
<!-- START BLOCK : function_since -->
<DT><B>Since:</B>
<DD>{functionSince}</DD>
<!-- END BLOCK : function_since -->
<!-- START BLOCK : function_version -->
<DT><B>Version:</B>
<DD>{functionVersion}</DD>
<!-- END BLOCK : function_version -->
<DT><B>Definition:</B>
<DD>Defined in {functionFile} at line {fileLine}
<!-- START BLOCK : function_examples -->
<DT><B>Examples and Use Cases:</B>
<!-- START BLOCK : loop_function_examples -->
<DD>{exampleDesc}
<!-- END BLOCK : loop_function_examples -->
<!-- END BLOCK : function_examples -->
<!-- START BLOCK : function_deprecated -->
<DT><B>WARNING! This function is deprecated</B>
<!-- END BLOCK : function_deprecated -->
</DL></DD></DL>
<P ALIGN="left"><A HREF="#navbar_top">top</A>
<HR>
<!-- END BLOCK : loop_function_detail -->
<!-- END BLOCK : function_detail -->

<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../project_overview.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>File</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../project_tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../project_index.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../documentation.html"><FONT CLASS="NavBarFont1"><B>Docs</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>{projectName}</b></EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2" COLSPAN="3"><FONT SIZE="-2">
&nbsp;{prevFile}&nbsp;
&nbsp;{nextFile}</FONT></TD>
</TR>
<TR>
<TD VALIGN="top"><FONT SIZE="-2">
  SUMMARY:&nbsp;<A HREF="#constant_summary" CLASS="NavBarCell3">CONSTANT</A>&nbsp;|&nbsp;<A HREF="#function_summary" CLASS="NavBarCell3">FUNCTION</A></FONT></TD>
<TD VALIGN="top"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#constant_detail" CLASS="NavBarCell3">CONSTANT</A>&nbsp;|&nbsp;<A HREF="#function_detail" CLASS="NavBarCell3">FUNCTION</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
<!-- START BLOCK : bug_submit -->
<font size="-1"><a href="{homePage}">Submit a bug or feature</a></font><br>
<!-- END BLOCK : bug_submit -->
<font size="-1">Copyleft 2002-{year} phpScribe<sup><font size='-2'>TM</font></sup> All rights reserved.
</BODY>
</HTML>
Return current item: PhpScribe Documentation Generator