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

Home > Articles > Web Design & Development > CSS

CSS Coding Guidelines

Like this article? We recommend

Like this article? We recommend

Coding Style

It might appear as though style sheets are too simple for the developer to need to worry about coding style, but, in practice, the capability to quickly read and understand styles is vital. Using a consistent set of coding style conventions will ensure that both the developer and those who follow him can more easily read, understand, and maintain the code in the future. This section presents some basic guidelines for writing clearer CSS code:

  • Use a standardized file-naming scheme.
  • Position styles consistently in documents.
  • Use character case consistently.
  • Use indentation and alignment consistently.
  • Use descriptive identifiers for classes and IDs.

Use a Standardized File-Naming Scheme

Select filenames that describe the purpose and usage context of the styles. Use a .CSS extension to communicate to developers and administrators that this is an external style sheet file. Using the .CSS extension also ensures that Web server software applies the correct handling to the file.

As with all source code files, it's best to adopt a set of rules for valid filenames. Filenames should consist of alphanumeric characters. If symbols are allowed, they should be limited to the "-", "_", and "." symbols. While names should be descriptive, they should be limited to a reasonable length. About 16 characters is long enough to be descriptive but short enough that URLs don't get ridiculously long.

Position Styles Consistently in Documents

Keep source code files well organized to make them easier to understand and maintain. Place embedded styles in the HTML document's head section, after any links to external style sheets. The embedded styles can appear either before or after sections of client-side script, but then be sure to use the same convention in all source files.

As illustrated in Listing 8, it's also a good idea to surround embedded styles with the HTML comment characters (<!-- and -->), to hide them from older browsers that do not understand CSS.

Listing 8: An HTML Document Head Section with an Embedded Style Sheet

<head>
 <!--
 <style type="text/css">
  h1 {
   font-family  : Courier New;
   font-size   : 40pt;
   letter-spacing : +2pt;
   color     : MediumBlue;
  }
 </style>
 <script language="JavaScript">
  function makeProper(vElement) {
   var sText = vElement.value;
   var c = sText.substring(0,1).toUpperCase();
   var sRight = sText.substring(1, sText.length);
   vElement.value = c + sRight;
  } 
 </script>
 -->
</head>

Also organize the styles in a style sheet according to a consistent scheme. For example, organize the style sheet into three sections, one for styles bound to HTML tags, one for styles bound to classes, and one for those bound to individual element IDs. Then within each group, organize the styles alphabetically. This scheme will make large style sheets much easier to maintain.

Use Character Case Consistently

Select an approach to using character case to maximize readability in CSS, and follow it consistently. One approach that works well is to use all lowercase attribute names and mixed-case attribute values for readability. The code in Listing 8 illustrates this approach.

Use Indentation and Alignment Consistently

Listing 8 also demonstrates the use of indentation and alignment to improve the readability of the code. Indenting the attribute-value pairs that make up each style helps organize the code, especially in style sheets containing many styles. Lining up all the attribute values helps the reader to mentally summarize each style.

Use Descriptive Identifiers for Classes and IDs

As we discussed in the previous article, the selector for a style can refer to a class or ID value. The Web developer defines these identifiers in the HTML. CSS code will be much clearer if the developer uses descriptive identifiers. For example, a class name such as RedHighlight is much more descriptive than a generic class identifier such as Class1. Other developers will be much more likely to reuse a style with a selector of RedHighlight because it is obvious at a glance what it does. This might seem like a laughably obvious practice, but it's amazing how many development tools use poor identifier names for automatically generated code.

As with all programming, the adoption of standard programming style conventions for CSS helps maximize the maintainability and reusability of code. Understanding how CSS works helps developers make decisions that maximize the application's performance.

Conclusion

This article concludes our introduction to the fundamental concepts of CSS, how it fits into a Web application, and guidelines for using CSS to help maximize the maintainability and reusability of Web application code. You've seen how CSS provides a language to allow Web developers to do two things: to specify enhanced style characteristics for the elements of a Web document in a standardized fashion, and to separate the content of a Web document from the rules about how to display it. The next article in this series kicks off our look at client-side scripting, the primary method of introducing greater interactivity into Web applications.

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