PIKT

Samples: HTML Head Macros

PIKT Logo
Home FAQ News Intro Samples Tutorial Reference Software Authors Licensing SiteSearch


The macros in this selected portion of the sample html_macros.cfg configuration file below are used for specifying the head section of an HTML document.

///////////////////////////////////////////////////////////////////////////////
//
// html_macros.cfg -- macros for html formatting
//
///////////////////////////////////////////////////////////////////////////////

...

pikt_description        Unix/Linux software for system monitoring,
                        configuration management, system security,
                        job scheduling, and much more.

pikt_author             Robert Osterlund

pikt_copyright          PIKT is a registered trademark of the University of
                        Chicago. All Rights Reserved. Copyright (c) 1998-2005
                        by Robert Osterlund. PIKT is free software. You may
                        redistribute it and/or modify it under the terms of
                        the GNU General Public License (GPL) as published by
                        the Free Software Foundation.

///////////////////////////////////////////////////////////////////////////////

// page head section

doctype                 <!DOCTYPE HTML PUBLIC "-\/\/W3C\/\/DTD
                        HTML 4.01 Transitional\/\/EN"
                        "http:\/\/www.w3.org/TR/html4/loose.dtd">

meta_content_language   <meta http-equiv="Content-Language" content="en-us">

meta_content_type       <meta http-equiv="Content-Type" content="text/html;
                        charset==_iso-8859-1">

meta_description(T)     <meta name="description" content="(T)">

meta_keywords(T)        <meta name="keywords" content="(T)">

meta_author(T)          <meta name="author" content="(T)">

meta_copyright(T)       <meta name="copyright" content="(T)">

...

///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
Using macros such as these, we can dispense for the most part with ugly, error-prone HTML tags and instead use the much shorter and more readable PIKT macro equivalents.

So, for example, instead of writing this:
<meta name="description" content="Unix/Linux software for system monitoring,
configuration management, system security, job scheduling, and much more.">
we would write this:
=meta_description(=pikt_description)
They both achieve the same result, but specifying the document header the second way with PIKT macros is clearer and much more compact.

Here is some HTML code from the PIKT home page that uses the HTML head macros:
=doctype
<html>
<head>
<title>PIKT - system monitoring, configuration management software</title>
=meta_content_language
=meta_content_type
=meta_description(=pikt_description)
=meta_keywords(system monitoring configuration management software security
unix linux open source free)
=meta_author(=pikt_author)
=meta_copyright(=pikt_copyright)
</head>
After PIKT macro preprocessing, here is the result:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>PIKT - system monitoring, configuration management software</title>
<meta http-equiv="Content-Language" content="en-us">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta name="description" content="Unix/Linux software for system monitoring,
configuration management, system security, job scheduling, and much more.">
<meta name="keywords" content="system monitoring configuration management
software security unix linux open source free">
<meta name="author" content="Robert Osterlund">
<meta name="copyright" content="PIKT is a registered trademark of the
University of Chicago. All Rights Reserved. Copyright (c) 1998-2005 by
Robert Osterlund. PIKT is free software. You may redistribute it and/or
modify it under the terms of the GNU General Public License (GPL) as
published by the Free Software Foundation.">
</head>
With similar HTML preprocessing, the principal PIKT Maintainer manages more than 650 web pages (at last count) over several different Web sites (including pikt.org, as you might expect).

[For more examples, see Samples.]


Home | FAQ | News | Intro | Samples | Tutorial | Reference | Software | Authors | Licensing | SiteSearch
Links | SiteIndex | Pikt-Users | Pikt-Workers | Contribute | ContactUs | Top of Page
Page best viewed at 1024x768.   Page last updated 2005-06-22.
This site is PIKT® powered.
PIKT® is a registered trademark of the University of Chicago.
Copyright © 1998-2005 Robert Osterlund.  All rights reserved.

Computer Books at Amazon.com

HTML & XHTML: The Complete Reference
HTML & XHTML: The Complete Reference

HTML 4 for Dummies
HTML 4 for Dummies

Dynamic HTML: The Definitive Reference
Dynamic HTML: The Definitive Reference

Securing Web Services with WS-Security
Securing Web Services with WS-Security

PHP Pocket Reference
PHP Pocket Reference