Doc: replacement of $g_page_title by $g_top_include_page

Fixes #21087
mantisbt · Jun 11, 2016 · ab9db31 · ab9db31
1 parent 416a26e
commit ab9db31
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 12 deletions.
diff --git a/docbook/Admin_Guide/en-US/config/display.xml b/docbook/Admin_Guide/en-US/config/display.xml
@@ -14,14 +14,6 @@
 				</para>
 			</listitem>
 		</varlistentry>
-		<varlistentry>
-			<term>$g_page_title</term>
-			<listitem>
-				<para>This is a heading that is displayed in the viewing area of
-					the page.
-				</para>
-			</listitem>
-		</varlistentry>
 		<varlistentry>
 			<term>$g_favicon_image</term>
 			<listitem>

diff --git a/docbook/Admin_Guide/en-US/config/html.xml b/docbook/Admin_Guide/en-US/config/html.xml
@@ -50,16 +50,43 @@
 		<varlistentry>
 			<term>$g_bottom_include_page</term>
 			<listitem>
-				<para>If this page exists it will be displayed at the bottom of
-					every page. It makes a good company branding include page.
+				<para>Specifies a file to be included at the bottom of each page.
+					It can be used e.g. for company branding, to include Google
+					Analytics script, etc.
 				</para>
 			</listitem>
 		</varlistentry>
 		<varlistentry>
 			<term>$g_top_include_page</term>
 			<listitem>
-				<para>If this page exists it will be displayed at the top of every
-					page. It makes a good company branding include page.
+				<para>Specifies a file to be included at the top of each page.
+					It can be used e.g. for company branding.
+				</para>
+				<para>If a file is supplied, the logo specified by
+					<literal>$g_logo_image</literal> (see
+					<xref linkend="admin.config.display" />) will not be shown,
+					and the include file will have to handle display of the logo.
+					To do so you can use the <literal>html_print_logo()</literal>
+					API function, which will display the logo with an URL link if
+					one has been specified in <literal>$g_logo_url</literal>
+				</para>
+				<para>Example top include PHP file with logo and centered page title:
+<programlisting>
+&lt;div id="banner" style="display: flex; align-items: center;"&gt;
+	&lt;div style="width: 10%;"&gt;
+		&lt;?php html_print_logo(); ?&gt;
+	&lt;/div&gt;
+
+	&lt;div class="center"&gt;
+		&lt;span class="pagetitle"&gt;
+			&lt;?php global $g_window_title; echo $g_window_title; ?&gt;
+		&lt;/span&gt;
+	&lt;/div&gt;
+
+	&lt;div style="width: 10%;"&gt;
+	&lt;/div&gt;
+&lt;/div&gt;
+</programlisting>
 				</para>
 			</listitem>
 		</varlistentry>