Publishers of technology books, eBooks, and videos for creative people

Home > Articles > Web Design & Development > HTML/XHTML

HTML Coding Guidelines

When using HTML, it is important to plan for maintainable, reusable code and to adopt a consistent policy on coding style. Scott Loban gives you some tips to make this easier.
Like this article? We recommend

Like this article? We recommend

The previous article in this series continued our introduction to HTML in Web applications with a discussion of the core elements of both HTML and Web applications in general. This article explores the use of HTML in more detail, presenting a number of coding and design guidelines that will help improve the maintainability and reusability of HTML code.

The result of a successful software-development project is a body of source code that represents the solution to a business need at a specific point in time. As conditions change, this solution might need to be updated for it to continue to meet business needs. In addition, software development is an expensive undertaking. As with any business resource, it is desirable to leverage source code as fully as possible to obtain maximum value.

Leaders of software-development projects should keep these considerations in mind while planning and executing the project. Maximizing the maintainability and reusability of source code is the key to obtaining full value from software-development expenditures.

The previous two articles presented you with a clearer picture of what elements make up a Web application and the role of HTML in these applications. Now we will turn our attention to the HTML code itself. This section presents some general guidelines for coding HTML that will help improve readability, maintainability, and code reuse.

Design Guidelines

The first and best opportunity for improving HTML code comes during the planning stage. When designing the Web application, consider the following general guidelines for organizing internal document structure and the HTML code:

  • Plan ahead.
  • Encapsulate formatting/styles.
  • Use include files wisely.
  • Serve HTML directly.
  • Understand the HTML document structure.
  • Use metatags.

Plan Ahead

Possibly one of the most important things that you can do to maximize the maintainability and reusability of HTML code is to plan ahead. Establish standards for coding style and practices, document these standards, and then stick with them.

Standards for coding style often include rules about the use of capitalization, indentation, naming, line length, and comments. Standards for programming practice might include rules about the use of external files, source code control, testing, documentation, and reporting.

Encapsulate Formatting/Styles

The Web developer can explicitly specify many display characteristics of HTML elements, including fonts, colors, and positioning, by setting the element's style property. For example, the following code specifies that the paragraph element should be displayed at a position 10 pixels from the left of the browser window and 20 pixels from the top. It further specifies that the browser should use 24-point Verdana font and should display the element in blue.

<p style="position:absolute;
     pixel-left:10px;pixel-top:20px;
     font-family:Verdana;font-size:24pt;
     color:Blue">Some text</p>

The inline style shown in the previous code demonstrates one way in which the developer can use Cascading Style Sheets (CSS) to specify characteristics of HTML elements. CSS also allows the developer to encapsulate styles within the document and even in separate files. We will explore CSS in more detail in later articles in this series, but, as a general guideline, it is better to encapsulate styles whenever possible rather than to use inline styles. The reason is manageability. When the specifications for a style change, it is much easier to change it in one style sheet than to change it in every element that applies the style.

Use Include Files Wisely

The developer can also encapsulate HTML and script code in files separately from the main document. The #include directive will cause the specified external file to be inserted into the current page at that point. For example, the following code includes an external file whose name implies that it contains JavaScript functions for data or input validation:

<!-- #include file="../include/validation.js" -->

Include files are often used to maintain script code with similar functions grouped together. This is a good approach to application design to enhance code reusability. The same include file might be used by multiple pages in several different applications.

However, it is important to remember that the entire external file will be included; there is no mechanism to include only the portion of HTML or script code actually used by the current page. Therefore, it is important to set up include files wisely, to minimize the inclusion of extraneous code. The benefits gained through the use of included external files will be explored further in later articles on client-side scripting.

Serve HTML Code Directly

Many modern Web applications are data-driven. In these applications, large parts of both the server-side and the client-side code are generated programmatically at runtime. While this is the nature of a data-driven Web application, it can make source code much harder to read and reuse.

Whenever possible, use HTML code directly in .HTM or .HTML files, instead of writing HTML-formatted strings from scripts. For example, look at the following code for the start tag of a form element:

<form action="input.asp" 
   name="frmDataInput"
   language="JavaScript"
   onsubmit='return validate();'>

Now compare the following code that uses the ASP Response.Write method to generate the same HTML code. It is much more difficult to read and maintain than the direct HTML:

<%
 Response.Write "<form action=""input.asp""" & vbCrLf
 Response.Write "name=""frmDataInput""" & vbCrLf
 Response.Write "language=""JavaScript""" & vbCrLf
 Response.Write "onsubmit='return validate();'>" & vbCrLf
%>

Besides manageability, there are other reasons to maintain HTML code in straight HTML source files. One of these is that development tools for HTML code work best on HTML source. For example, syntax highlighting will usually not work for the HTML code in the previous code listing. Another reason is to reduce the multiple nested quotes that commonly crop up when generating HTML from script.

However, there are times when the developer must use script to dynamically generate HTML that reflects the current state of the system. However, when it is an option, straight HTML is much more manageable. If you must generate HTML from script, then at least have the script write out the HTML code with good formatting so that the generated source code is easier to read and understand.

HTML Document Structure

An HTML document consists of two distinct sections: the head and the body. The Web server also prepends an informational header to the text stream for evaluation by the browser. The Web developer can make the application better structured by using the HTML document structure appropriately.

The <html></html> tag pair delimits the entire content of the Web page and signals that the document is in HTML format. There are two subsections in the document: the head, delimited by the <head></head> tag pair, and the body, enclosed within the <body></body> tags. Listing 1 illustrates the structure of an HTML document.

Listing 1: HTML Document Structure

<html>
<head>
 <title>Document Title</title>
 <meta name="Description" content="HTML document sample with metadata">
 <meta name="Keywords" content="document structure, section, metadata">
</head>
<body>
</body>
</html>

The head section of an HTML document has one required subsection, the title. Delimited by the <title></title> tag pair, this element is usually used for a short descriptive document title. Other than the title, the head section does not contain content intended for regular display on the browser. Instead, it provides a place to organize information about the document itself and resources used to display the content, such as scripts and style sheets.

Information about the document itself is an example of metadata (see the sidebar entitled "Metadata"). Metadata for HTML documents is included in the head section using the <meta> tag, which is discussed further in the next section.

Metadata

Metadata is often defined as "data about data." A better description is information that describes or characterizes the data—both its content and container. Like the first paragraph of a well-crafted news story, metadata answers the questions who, what, where, when, why, and how.

Use Metatags

HTML <meta> tags are used to delimit information about the HTML document—for example, information about the document author and copyright. Keywords and description fields can be used to provide an index of the content and code in the document.

Peachpit Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from Peachpit and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about Peachpit products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites; develop new products and services; conduct educational research; and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email ask@peachpit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by Adobe Press. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.peachpit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020