CINXE.COM

<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" version="XHTML+RDFa 1.0" dir="ltr" xmlns:fb="http://ogp.me/ns/fb#" xmlns:og="http://ogp.me/ns#"> <head profile="http://www.w3.org/1999/xhtml/vocab"> <meta name="HandheldFriendly" content="true" /> <meta name="viewport" content="width=device-width" /> <meta name="MobileOptimized" content="width" />  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="description" content="This page contains guidelines for Drupal module and theme developers to use when writing user interfaces text (e.g., buttons, labels, in" /> <meta name="generator" content="Drupal 7 (https://www.drupal.org)" /> <link rel="image_src" href="https://www.drupal.org/sites/all/themes/bluecheese/images/og.jpg" /> <link rel="canonical" href="https://www.drupal.org/docs/develop/user-interface-standards/interface-text" /> <link rel="shortlink" href="https://www.drupal.org/node/604342" /> <meta property="og:site_name" content="Drupal.org" /> <meta property="og:type" content="article" /> <meta property="og:url" content="https://www.drupal.org/docs/develop/user-interface-standards/interface-text" /> <meta property="og:title" content="Interface text" /> <meta property="og:description" content="This page contains guidelines for Drupal module and theme developers to use when writing user interface (UI) text, like buttons, labels, in-page help, descriptions below fields, and (error) messages. These guidelines are being applied in Drupal core. For consistency, apply these guidelines in contributed modules, too." /> <meta property="og:updated_time" content="2024-11-20T22:08:04+00:00" /> <meta property="article:published_time" content="2009-10-14T15:06:40+00:00" /> <meta property="article:modified_time" content="2024-11-20T22:08:04+00:00" /> <title>Interface text | User interface standards | Drupal Wiki guide on Drupal.org</title> <link type="text/css" rel="stylesheet" href="/files/advagg_css/css__vwdslBVX8xVWQ4hx4mWxIC59-lKGPldWkMIm435ispk__msT4O19F5udTbXsVQpyNk2EFYlbaoLwufqq_ZcdDcB0__YaNGWokqa69Wq8hHbkE322PVJ8I-GmpfBsT8LGsMpcI.css" media="all" /> <link type="text/css" rel="stylesheet" href="/files/advagg_css/css__Xi-PZpvKTY78w7l1WNsqwUA52MIupHJebCMiX34Ugt0__D_EUHDAfEQdxcLiSDY7hREUWkG1Ge56_h2z3Er8V188__YaNGWokqa69Wq8hHbkE322PVJ8I-GmpfBsT8LGsMpcI.css" media="all" /> <link type="text/css" rel="stylesheet" href="/files/advagg_css/css__WF0PRotZAhCcl0aJjY5W2LYj8UwiYuB2dZEFluOh3Tc__FviX13FUB-Ppa2XB29BUIJQZ1Wg-F5XiDE7XD5y7mjQ__YaNGWokqa69Wq8hHbkE322PVJ8I-GmpfBsT8LGsMpcI.css" media="all" /> <link type="text/css" rel="stylesheet" href="/files/advagg_css/css__Fx0_w1L9q3nwzXnALG7UfjLF34FGYgJTz636-GWbM6k__0jWLTEHP3h5U5RcXuZcFhf0DdvRdzP3_wzCVNT015Ls__YaNGWokqa69Wq8hHbkE322PVJ8I-GmpfBsT8LGsMpcI.css" media="all" /> <link type="text/css" rel="stylesheet" href="/files/advagg_css/css__pWCOPcaPe71p3QyGrAeqEd6dwL_n27prYOjnWQj4jVI__fR6RV6fh70jWL18FMzdVQpGUyYT8iL9Vw8wnms1DdQA__YaNGWokqa69Wq8hHbkE322PVJ8I-GmpfBsT8LGsMpcI.css" media="all" /> <link type="text/css" rel="stylesheet" href="/files/advagg_css/css__mlCLWKqAJJ-E-mMVCEmFp-7SE_XsgAxpf7HS-FcVqB0__7Tgy6u_PBeTp3b4s5UumhQPx9mJ_jhs1Z-WvSrqxAHk__YaNGWokqa69Wq8hHbkE322PVJ8I-GmpfBsT8LGsMpcI.css" media="all" /> <link type="text/css" rel="stylesheet" href="/files/advagg_css/css__QPp1snPjYt_xYr0c_V0IORcEElkIUBBBrvOB4ZE0Gnw__8jkPtXCYcQv4spuNwtiMBMbZXgCS-2GouDqwnCBDPRE__YaNGWokqa69Wq8hHbkE322PVJ8I-GmpfBsT8LGsMpcI.css" media="all" /> </head> <body class="html not-front not-logged-in no-sidebars page-node page-node- page-node-604342 node-type-documentation drupalorg-site-main panels-layout og-context og-context-node og-context-node-2804041" > <div id="skip-link" tabindex="-1"> <a class="element-invisible element-focusable" href="#content">Skip to main content</a> <a class="element-invisible element-focusable skip-link-search" href="#search-block-form">Skip to search</a> </div> <div class="region region-page-top"> <noscript aria-hidden="true"><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-W36H8DW" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript> <div id="drupalorg-crosssite-gdpr">Can we use first and third party cookies and web beacons to <a href="https://www.drupal.org/terms">understand our audience, and to tailor promotions you see</a>?<br><button class="yes">Yes, please</button><button class="no">No, do not track me</button></div> </div> <div id="nav-header"> <div class="menu-nav"> <a class="nav-btn" id="nav-open-btn" href="#block-system-main-menu"><img src="/sites/all/themes/bluecheese/images/icon-w-menu.svg" alt="Main menu"></a> </div> <nav id="navigation-inner" class="container-12" role="navigation"> <div class="region region-navigation"> <div id="block-system-main-menu" class="block block-system block-menu"> <div class="block-inner"> <div class="content"> <div class="menu-block"><ul class="menu button"><li class="first leaf"><a href="/home" title="Drupal.org home page">Drupal.org home</a></li> <li class="expanded"><a href="/about" title="">Why Drupal?</a><div class="menu-block"><ul class="menu button"><li class="first leaf"><a href="/about" title="Learn about Drupal">About Drupal</a></li> <li class="leaf"><a href="/docs/getting-started/understanding-drupal/overview-of-drupal" title="">Platform overview</a></li> <li class="leaf"><a href="/about/11" title="">Drupal 11</a></li> <li class="leaf"><a href="/features/content-authoring" title="">Content Authoring</a></li> <li class="leaf"><a href="/features/content-as-a-service" title="">Content as a Service</a></li> <li class="leaf"><a href="/features/decoupled" title="">Decoupled</a></li> <li class="leaf"><a href="/features/accessibility" title="">Accessibility</a></li> <li class="leaf"><a href="/features/marketing-automation" title="">Marketing Automation</a></li> <li class="leaf"><a href="/features/multilingual" title="">Multilingual</a></li> <li class="leaf"><a href="/features/security" title="">Security</a></li> <li class="leaf"><a href="/features/personalization" title="">Personalization</a></li> <li class="leaf"><a href="/case-studies" title="View case studies to see how your peers have built success on Drupal">Case studies</a></li> <li class="leaf"><a href="https://www.drupal.org/association/beyond-the-build" title="">Video series</a></li> <li class="last leaf"><a href="/about/in-the-news" title="">News</a></li> </ul></div></li> <li class="expanded"><a href="/industries" title="Examples of solutions built on Drupal">Use cases</a><div class="menu-block"><ul class="menu button"><li class="first leaf"><a href="/developers" title="">For Developers</a></li> <li class="leaf"><a href="/marketers" title="Why marketers should choose Drupal for their ambitious digital experiences">For Marketers</a></li> <li class="leaf"><a href="/industries/ecommerce" title="">E-commerce</a></li> <li class="leaf"><a href="/industries/education" title="">Education</a></li> <li class="leaf"><a href="/industries/fintech" title="">FinTech</a></li> <li class="leaf"><a href="/industries/government" title="">Government</a></li> <li class="leaf"><a href="/industries/healthcare" title="">Healthcare</a></li> <li class="leaf"><a href="/industries/hightech" title="">High Tech</a></li> <li class="leaf"><a href="/industries/nonprofit" title="">Nonprofit</a></li> <li class="leaf"><a href="/industries/retail" title="">Retail</a></li> <li class="last leaf"><a href="/industries/travel" title="">Travel</a></li> </ul></div></li> <li class="expanded"><a href="/documentation" title="Resources to help you on your Drupal journey">Resources</a><div class="menu-block"><ul class="menu button"><li class="first leaf"><a href="/docs/getting-started/installing-drupal" title="">Installing Drupal</a></li> <li class="leaf"><a href="/documentation" title="Drupal Documentation">Documentation</a></li> <li class="leaf"><a href="/docs/user_guide/en/index.html" title="The Drupal 8 user guide will get you up to speed in no time">User guide</a></li> <li class="leaf"><a href="/docs/official_docs/local-development-guide" title="">Local Development Guide</a></li> <li class="leaf"><a href="/security" title="Find information about security releases for Drupal">Security</a></li> <li class="leaf"><a href="/news" title="News about the Drupal ecosystem">News</a></li> <li class="leaf"><a href="/planet" title="">Blog</a></li> <li class="last leaf"><a href="/about/drupal-7/d7eol/partners" title="Find help for your Drupal 7 migration">Migrate from D7</a></li> </ul></div></li> <li class="expanded"><a href="/drupal-services" title="Buy Drupal Products and Services">Services</a><div class="menu-block"><ul class="menu button"><li class="first leaf"><a href="/drupal-services" title="View the Drupal service provider marketplace">Find an Agency Partner</a></li> <li class="leaf"><a href="/hosting" title="Find trusted Drupal hosting providers">Find Integrations & Hosting</a></li> <li class="leaf"><a href="/training" title="Find expert Drupal training">Find Drupal Training</a></li> <li class="leaf"><a href="/association/become-a-drupal-certified-partner" title="">Become a Certified Partner</a></li> <li class="last leaf"><a href="/about/drupal-7/d7eol/migration-resource-center/enterprise" title="">Find a D7 migration partner</a></li> </ul></div></li> <li class="expanded"><a href="/community" title="Drupal Community">Community</a><div class="menu-block"><ul class="menu button"><li class="first leaf"><a href="/community/contributor-guide" title="">How to Contribute</a></li> <li class="leaf"><a href="/community" title="View the community portal and find all the ways you can contribute to Drupal">About the Community</a></li> <li class="leaf"><a href="/support" title="">Support</a></li> <li class="leaf"><a href="/project/governance" title="">Community Governance</a></li> <li class="last leaf"><a href="https://jobs.drupal.org" title="">Jobs/Careers</a></li> </ul></div></li> <li class="expanded"><a href="/community/events" title="Find Drupal Events around the world, from the official DrupalCons, to community Camps and Meet-Ups">Events</a><div class="menu-block"><ul class="menu button"><li class="first leaf"><a href="https://events.drupal.org/barcelona2024" title="">DrupalCon Barcelona 2024</a></li> <li class="leaf"><a href="https://events.drupal.org/singapore2024" title="">DrupalCon Singapore 2024</a></li> <li class="leaf"><a href="https://events.drupal.org/atlanta2025" title="">DrupalCon Atlanta 2025</a></li> <li class="last leaf"><a href="/community/events" title="">Community Events</a></li> </ul></div></li> <li class="expanded"><a href="/download" title="Download and Extend Drupal">Download</a><div class="menu-block"><ul class="menu button"><li class="first collapsed"><a href="/download" title="Build your solution on Drupal">Download</a></li> <li class="leaf"><a href="/project/modules" title="Find modules to extend Drupal to meet any need">Modules</a></li> <li class="leaf"><a href="/project/themes" title="Browse themes as a starting point for making your Drupal site your own">Themes</a></li> <li class="leaf"><a href="/project/distributions" title="Use a distribution to start with a version of Drupal customized to purpose">Distributions</a></li> <li class="leaf"><a href="/project/issues" title="Dive into the issues queues and contribute back to Drupal">Issue queues</a></li> <li class="last leaf"><a href="https://git.drupalcode.org/project/drupal" title="">Browse Repository</a></li> </ul></div></li> <li class="expanded"><a href="/association" title="About the Drupal Association - the non-profit that supports the Drupal project">Give</a><div class="menu-block"><ul class="menu button"><li class="first leaf"><a href="/association" title="Learn about the Drupal Association - the nonprofit that supports the Drupal project">Drupal Association</a></li> <li class="leaf"><a href="/association/organization-membership" title="Learn more about the organizations that support the Drupal Association and our mission">Become an Organization Member</a></li> <li class="leaf"><a href="/association/become-a-drupal-certified-partner" title="">Become a Certified Partner</a></li> <li class="leaf"><a href="/association/RippleMakers" title="">Become a Ripple Maker</a></li> <li class="leaf"><a href="/association/donate" title="">Make a Donation</a></li> <li class="leaf"><a href="/association/discover-drupal" title="">Discover Drupal</a></li> <li class="last leaf"><a href="https://www.drupal.org/swag?utm_source=drupalorg&utm_medium=banner&utm_campaign=drupal_swag_shop_2020_09_17" title="Purchase Drupal merchandise and be the coolest kid on the block">Drupal Swag Shop</a></li> </ul></div></li> <li class="last expanded"><a href="/try-drupal" title="Try Drupal">Demo</a><div class="menu-block"><ul class="menu button"><li class="first leaf"><a href="/try-drupal" title="Demo Drupal online with a Drupal platform partner">Demo online</a></li> <li class="last leaf"><a href="/download" title="">Download</a></li> </ul></div></li> </ul></div><a class="close-btn" href="#top">Return to content</a> </div> </div> </div> <div id="block-search-form" class="block block-search"> <div class="block-inner"> <div class="content"> <form action="/docs/develop/user-interface-standards/interface-text" method="post" id="search-block-form" accept-charset="UTF-8"><div><div class="container-inline"> <h2 class="element-invisible">Search form</h2> <div class="form-item form-type-textfield form-item-search-block-form"> <label class="element-invisible" for="edit-search-block-form--2">Search </label> <input placeholder="Search…" type="text" id="edit-search-block-form--2" name="search_block_form" value="" size="15" maxlength="128" class="form-text" /> </div> <div class="form-actions form-wrapper" id="edit-actions"><input alt="Search" type="image" id="edit-submit" name="submit" value="Search" src="/sites/all/themes/bluecheese/images/icon-w-search.svg" class="form-submit" /></div><input type="hidden" name="form_build_id" value="form-2O5n37CqDX_3dDsyG7gGLzCBceJca5Jw-Z9c3uXnqW8" /> <input type="hidden" name="form_id" value="search_block_form" /> </div> </div></form> </div> </div> </div> <div id="block-system-user-menu" class="block block-system block-menu"> <div class="block-inner"> <div class="content"> <div class="menu-block"><ul class="menu"><li class="button default"><a href="#block-system-user-menu"><img src="https://www.drupal.org/sites/all/themes/bluecheese/images/icon-w-user.svg" alt="Log in, view profile, and more"></a><ul><li class="first leaf"><a href="/user/login?destination=node/604342" title="">Log in</a></li> <li class="last leaf"><a href="/user/register?destination=node/604342" title="">Create account</a></li> </ul></li></ul></div> </div> </div> </div> </div> </nav> </div> <div id="header" class="clearfix"> <div id="header-inner" class="container-12 clearfix"> <div id="header-left"> <div id="site-name"><a href="/documentation">Documentation</a></div> </div> <div id="header-right"> <div class="region region-header"> <div id="block-drupalorg-search-documentation" class="block block-drupalorg"> <div class="block-inner"> <div class="content"> <form class="container-inline" action="/docs/develop/user-interface-standards/interface-text" method="post" id="drupalorg-documentation-search-form" accept-charset="UTF-8"><div><input type="hidden" name="form_build_id" value="form-rr0GCosvXEi7O4b1RuOJwhJrPZHm958w-Z_twcsYzQM" /> <input type="hidden" name="form_id" value="drupalorg_documentation_search_form" /> <div class="form-item form-type-textfield form-item-drupalorg-documentation-search-form"> <label class="element-invisible" for="edit-drupalorg-documentation-search-form--2">Search </label> <input placeholder="Search documentation…" type="text" id="edit-drupalorg-documentation-search-form--2" name="drupalorg_documentation_search_form" value="" size="15" maxlength="128" class="form-text" /> </div> <div class="form-actions form-wrapper" id="edit-actions--2"><input alt="Search" type="image" id="edit-submit--2" name="submit" value="Search" src="/sites/all/themes/bluecheese/images/icon-w-search.svg" class="form-submit" /></div></div></form> </div> </div> </div> </div> </div> </div> </div> <div id="banner" data-nosnippet> <div class="region region-banner"> <div id="block-drupalorg-announcements" class="block block-drupalorg"> <div class="block-inner"> <div class="content"> <div class="announcement"><img class="photo" src="https://www.drupal.org/files/styles/grid-2-2x-square/public/announcements/drupalcon-hexagon-icon-280X280px_2_0.png?itok=uzoGg7T8" width="280" height="280" alt="Announcement icon" title="Announcement icon" />Join us at DrupalCon Singapore from 9-11 December 2024, for three exciting days of Drupal content, training, contributions, networking, and the inaugural DrupalCon Splash Awards! Be part of this landmark event as we celebrate and expand Drupal's impact across Asia.</div> <div class="cta"><a href="https://events.humanitix.com/drupalcon-singapore-2024" class="global-announce-banner dc-singapore-registration">Get your tickets now</a></div> </div> </div> </div> </div> </div> <div id="page" class="clearfix"> <div class="breadbox"><nav class="breadcrumb container-12"><span><a href="/docs/develop">Develop</a></span><span><a href="/docs/develop/user-interface-standards">User interface standards</a></span></nav></div> <div id="main" role="main"> <div id="content" class="clearfix"> <div id="content-inner" class="clearfix"> <div class="region region-content"> <div id="block-system-main" class="block block-system"> <div class="block-inner"> <div class="content"> <div class="panelizer-view-mode node node-full node-documentation node-604342"> <div class="panel-display hydra panel-layout clearfix " > <div class="container preface clearfix panel-panel"> <div class="container-inner preface-inner panel-panel-inner"> </div> </div> <div class="container content clearfix"> <div class="container-inner content-inner panel-panel-inner"> <div class="column-content-region top-right-content column panel-panel"> <div class="column-content-region-inner top-right-content-inner column-inner panel-panel-inner"> <div class="panel-pane pane-block pane-drupalorg-carbon-ad-sidebar" > <div class="pane-content"> <script async type="text/javascript" src="//cdn.carbonads.com/carbon.js?serve=CKYIEKJI&placement=drupalorg" id="_carbonads_js"></script><div class="ad-explanation description">Advertising sustains the DA. Ads are hidden for members. <a href="/association/individual-membership">Join today</a></div> </div> </div> <div class="panel-separator"></div><div class="panel-pane pane-block pane-table-of-contents-toc-w-3y7froeoqmgrpcmgnphqwt4pi3" id="on-this-page" > <h3 class="pane-title"> On this page </h3> <div class="pane-content"> <div class="item-list"><ul class="anchor-list"><li class="anchor-list__item h3-tag first"><a href="/docs/develop/user-interface-standards/interface-text#interface-text-style" class="toc-link active">Style</a></li> <li class="anchor-list__item h3-tag"><a href="/docs/develop/user-interface-standards/interface-text#interface-text-ui-elements" class="toc-link active">UI Elements</a></li> <li class="anchor-list__item h3-tag"><a href="/docs/develop/user-interface-standards/interface-text#interface-text-wording" class="toc-link active">Word Choice</a></li> <li class="anchor-list__item h3-tag"><a href="/docs/develop/user-interface-standards/interface-text#interface-text-capitalization" class="toc-link active">Capitalization</a></li> <li class="anchor-list__item h4-tag"><a href="/docs/develop/user-interface-standards/interface-text#interface-text-title-link-heading" class="toc-link active">Page titles, links, and headings</a></li> <li class="anchor-list__item h4-tag"><a href="/docs/develop/user-interface-standards/interface-text#interface-text-module-theme-name" class="toc-link active">Module and theme names</a></li> <li class="anchor-list__item h4-tag"><a href="/docs/develop/user-interface-standards/interface-text#interface-text-block-page-perm" class="toc-link active">Block, page or permission</a></li> <li class="anchor-list__item h4-tag"><a href="/docs/develop/user-interface-standards/interface-text#interface-text-acronym" class="toc-link active">Acronyms, trade names, etc.</a></li> <li class="anchor-list__item h3-tag last"><a href="/docs/develop/user-interface-standards/interface-text#interface-text-tables" class="toc-link active">Table Text</a></li> </ul></div> </div> </div> <div class="panel-separator"></div><div class="panel-pane pane-block pane-og-menu-og-single-menu-block" id="user-interface-standards" > <h2 class="pane-title"> <a href="/docs/develop/user-interface-standards">User interface standards</a> </h2> <div class="pane-content"> <ul class="menu"><li class="first leaf"><a href="/docs/develop/user-interface-standards/form-elements">Form elements</a></li> <li class="leaf"><a href="/docs/develop/user-interface-standards/buttons">Buttons</a></li> <li class="leaf"><a href="/docs/develop/user-interface-standards/dropdown-buttons">Dropbutton</a></li> <li class="leaf"><a href="/docs/develop/user-interface-standards/radio-buttons">Radio buttons</a></li> <li class="leaf"><a href="/docs/develop/user-interface-standards/checkbox-and-checkboxes">Checkboxes</a></li> <li class="leaf"><a href="/docs/develop/user-interface-standards/select-list">Select list</a></li> <li class="leaf"><a href="/docs/develop/user-interface-standards/navigation">Navigation</a></li> <li class="leaf"><a href="/docs/develop/user-interface-standards/contextual-links">Contextual Links</a></li> <li class="leaf"><a href="/docs/develop/user-interface-standards/local-action">Local action</a></li> <li class="leaf"><a href="/docs/develop/user-interface-standards/tabs">Tabs</a></li> <li class="leaf"><a href="/docs/develop/user-interface-standards/details">Details</a></li> <li class="leaf"><a href="/docs/develop/user-interface-standards/fieldsets">Fieldsets</a></li> <li class="leaf"><a href="/docs/develop/user-interface-standards/vertical-tabs">Vertical tabs</a></li> <li class="leaf"><a href="/docs/develop/user-interface-standards/listings">Listings</a></li> <li class="leaf"><a href="/docs/develop/user-interface-standards/table">Table</a></li> <li class="leaf active-trail"><a href="/docs/develop/user-interface-standards/interface-text" class="active-trail active">Interface text</a></li> <li class="leaf"><a href="/docs/develop/user-interface-standards/machine-name">Machine name</a></li> <li class="leaf"><a href="/docs/develop/user-interface-standards/tours">Tours</a></li> <li class="last leaf"><a href="/docs/extending-drupal/contributed-modules/contributed-module-documentation/tour/tour-text-standards">Tour text standards</a></li> </ul> </div> </div> <div class="panel-separator"></div><div class="panel-pane pane-node-links" > <div class="pane-content"> </div> </div> </div> </div> <div class="column-content-region left-content column panel-panel "> <div class="column-content-region-inner left-content-inner column-inner panel-panel-inner"> <div class="panel-pane pane-node-title" > <div class="pane-content"> <h1>Interface text</h1> </div> </div> <div class="panel-separator"></div><div class="panel-pane pane-node-updated" id="last-updated-on" > <span class="pane-title"> Last <a href="/node/604342/discuss">updated</a> on </span> <div class="pane-content"> 20 November 2024 </div> </div> <div class="panel-separator"></div><div class="panel-pane pane-entity-field pane-node-body" > <div class="pane-content"> <div class="field field-name-body field-type-text-with-summary field-label-hidden"><div class="field-items"><div class="field-item even"><p>This page contains guidelines for Drupal module and theme developers to use when writing user interface (UI) text, like buttons, labels, in-page help, descriptions below fields, and (error) messages.</p> <p>These guidelines are being applied in Drupal core. For consistency, apply these guidelines in contributed modules, too.</p> <h3 id="interface-text-style"><a class="toc-anchor" title="Permalink to this headline" href="#interface-text-style"></a>Style</h3> <ul> <li>Use a neutral and polite tone</li> <li>Remember the purpose of the site; as most sites are used in professional environments, use appropriate wording</li> <li>Use the active voice, and make sure it is clear who performs a certain action <ul> <li>In sentences written in the active voice (rather the passive voice), the subject of the sentence performs the action denoted by the verb</li> <li>For example, if something works automatically and the user should know about it, the associated message could read "The system automatically deletes temporary files"</li> </ul> </li> <li>Use the imperative sentence structure when appropriate: "Delete unnecessary files"</li> <li>Follow the principle of less is more, keep interface text concise and to the point <ul> <li><a href="https://www.nngroup.com/videos/less-is-more/" rel="nofollow">Learn more about the principle of less is more</a></li> </ul> </li> <li>Avoid emotionally charged verbs and adjectives <ul> <li>For example, it is expected and normal that an admin is able to install a module, so there is no real <strong>success </strong>in it <ul> </ul> </li> </ul> </li> <li>Use single quotes to refer to other parts of the website <ul> <li>For example, the sentence "Indexing behavior can be adjusted using the 'Search settings' page." is appropriate, where 'Search settings' is a link</li> </ul> </li> <li>Use the ellipsis character, "…", instead of three dots.</li> <li>Do not use the word "please". This makes it sound as if the user is supposed to do a favor for someone</li> <li>Do not use the word "sorry", especially in error messages</li> <li>Do not use the pronoun "we", like in the sentence "We delete these files." It's often unclear who <strong>we<em> </em></strong>refers to</li> <li>Do not use contractions, like "you've", "can't", and "shouldn't", and so on. Use the complete phrase instead</li> </ul> <h3 id="interface-text-ui-elements"><a class="toc-anchor" title="Permalink to this headline" href="#interface-text-ui-elements"></a>UI Elements</h3> <ul> <li>Label all widgets, like buttons and fields. Do not provide help text in the label</li> <li>Use hyperlinks in calls for action <ul> <li>For example, in the call to action "There are no blog items to display. Add a blog item.", the sentence "Add a blog item" should be a hyperlink</li> </ul> </li> <li>Keep introductory text short, and do not describe options in detail <ul> <li>Ideally, though, any given screen and its behavior should be intuitive, making an introduction unnecessary</li> </ul> </li> <li>Do not describe default UI interaction usage patterns or behavior, like drag-and-drop</li> <li>Put longer, detailed descriptions on a ‘More help’ page</li> <li>Ensure the order of tabs or actions, where applicable, follows LEAD: List, Edit, Add, Delete</li> <li>Make sure link text describes what is on the linked page or what will happen if the link is clicked <ul> <li>Do not use "Click here" or a URL for a link text</li> </ul> </li> <li>Note that interface strings are filtered on unsafe html tags when they pass through functions like t(), l() and drupal_set_title() <ul> <li><a href="/docs/7/security/writing-secure-code/handle-text-in-a-secure-fashion" rel="nofollow">Learn more about how interface text is filtered</a></li> </ul> </li> <li>Always use a paired verb and noun as a menu link text, like "Add link", "Configure search", and so on</li> <li>Ensure that the first form field of each element is the name of the element followed by "name", like "Gallery name"</li> <li>Add descriptive text under form elements only when they would be unclear without them. Try to make the form label clear by itself</li> <li>Review the following guidelines for button text: <ul> <li>A submit button should always have the label "Save" (when the actual action is saving)</li> <li>A reset to defaults button should always have the label "Reset to defaults"</li> <li>A delete button should always have the label "Delete"</li> <li>A cancel button should always have the label "Cancel"</li> </ul> </li> </ul> <h3 id="interface-text-wording"><a class="toc-anchor" title="Permalink to this headline" href="#interface-text-wording"></a>Word Choice</h3> <ul> <li>Use the verb "Configure" to indicate actions, like "Configure links"</li> <li>Use the noun "Settings" to describe options to change behavior or functionality, like "Account settings"</li> <li>Use "Module"—not "Plugin" or "Extension"</li> <li>Use "Text format"—not "Input format" (as of Drupal 7)</li> <li>Use "Content" or "Content item"—not "Node", and "Content type" not "Node type". (This applies only to the content entities supplied by the core Node module)</li> <li>For generic references to content entities, use the terms "Entity" (not "Entity item"), "Entity type", and "Entity subtype" (not "bundle")</li> <li>Use "Post" only as a verb (as of Drupal 7)</li> <li>Use "Site"—not "Drupal" <ul> <li>Referring to Drupal by name complicates distributions, and users may not know the site is running on Drupal</li> </ul> </li> </ul> <p><a href="/drupalorg/style-guide/content" rel="nofollow">Learn more in the Drupal.org content style guide.</a></p> <h3 id="interface-text-capitalization"><a class="toc-anchor" title="Permalink to this headline" href="#interface-text-capitalization"></a>Capitalization</h3> <h4 id="interface-text-title-link-heading"><a class="toc-anchor" title="Permalink to this headline" href="#interface-text-title-link-heading"></a>Page titles, links, and headings</h4> <p>Page titles, links (in menus, too), and headings in Drupal should generally use sentence case capitalization, where only the first word is capitalized, except for proper nouns and other words that are generally capitalized by a more specific rule. Examples of sentence case capitalization include the following: "Block administration", "List menus", "Install new theme".</p> <h4 id="interface-text-module-theme-name"><a class="toc-anchor" title="Permalink to this headline" href="#interface-text-module-theme-name"></a>Module and theme names</h4> <p>Core and contributed modules and themes should use title case capitalization (e.g. Layout Builder), since module and theme names are proper names in English. Also, when referring to the name of a module or theme directly, such as in documentation, help texts, or descriptions, use the same convention of title case capitalization, since module and theme names are proper names in English.</p> <p>For example, the sentence "How to configure private forums with the Taxonomy Access Control module" is preferable to "How to configure private forums with the Taxonomy access control module". The latter is ambiguous: it could be misinterpreted to mean that there is a module named "Taxonomy" that is an example of an access control module or that we are using an unnamed module providing access control for Taxonomy.</p> <h4 id="interface-text-block-page-perm"><a class="toc-anchor" title="Permalink to this headline" href="#interface-text-block-page-perm"></a>Block, page or permission</h4> <p>When referring to a specific block, page, or permission, follows the capitalization used on the block's administration page, the page title, or the permission name shown on the 'Permissions' page, respectively. Wrap the name in quotation marks to set it off from the rest of the text.</p> <p>If this is in hook_help() text, make page titles into links to the page, and make permission names into links to the appropriate anchor/section on the 'Permissions' page.</p> <p>Alternatively, if you do not think it merits capitalization and quotes or a link, use lower-case. For example, you could refer to the <em>search page</em> or the <em>search block.</em> Keep in mind that this is not as specific as referring to the exact item, so the regular form is preferred in most cases, especially in help text where you can provide a link.</p> <h4 id="interface-text-acronym"><a class="toc-anchor" title="Permalink to this headline" href="#interface-text-acronym"></a>Acronyms, trade names, etc.</h4> <p>Drupal UI text should follow standard (all-caps) capitalization for acronyms, like CSS, WYSIWYG, UI, and so on. Also, use established capitalization for third-party trade names, like jQuery, JavaScript, and so on.</p> <h3 id="interface-text-tables"><a class="toc-anchor" title="Permalink to this headline" href="#interface-text-tables"></a>Table Text</h3> <ul> <li>Capitalize the first word in each column header, like "User since"</li> <li>When a table has a column for actions/operations to perform on the rows, name the column "Operations"</li> <li>If possible, put the available operations in one row; if that is not possible, put them underneath each other</li> <li>If the table contains no records: within the same table, display a concise call-to-action message with a link that, if followed, allows the user to add relevant content <ul> <li>Do this unless the emptiness of the table is the result of filtering</li> </ul> </li> </ul></div></div></div> </div> </div> </div> </div> <div class="column-content-region bottom-right-content column panel-panel"> <div class="column-content-region-inner bottom-right-content-inner column-inner panel-panel-inner"> <div class="panel-pane pane-views-panes pane-documentation-help-improve-pane" id="help-improve-this-page" > <h2 class="pane-title"> Help improve this page </h2> <div class="pane-content"> <div class="view view-documentation-help view-id-documentation_help view-display-id-improve_pane view-dom-id-1475f948f7d3ded540eb9882251f25c8"> <div class="view-content"> <div class="views-row views-row-1 views-row-odd views-row-first views-row-last"> <span class="views-field views-field-field-documentation-status"> <strong class="views-label views-label-field-documentation-status">Page status: </strong> <span class="field-content">No known problems</span> </span> <div class="views-field views-field-nothing"> <span class="field-content"><br /><strong>You can:</strong><br /> <ul> <li>Log in, click <a href="/node/604342/edit">Edit</a>, and edit this page</li> <li>Log in, click <a href="/node/604342/discuss">Discuss</a>, update the Page status value, and suggest an improvement</li> <li>Log in and <a href="/node/add/project-issue/documentation?title=Suggestion%20for%3A%20%28604342%29%20Interface%20text">create a Documentation issue</a> with your suggestion</li> </ul></span> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> <div class="container footer clearfix panel-panel"> <div class="container-inner footer-inner panel-panel-inner"> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div>  </div>  </div>  <div id="footer" role="contentinfo"> <div class="region region-footer"> <div id="block-drupalorg-documentation-license" class="block block-drupalorg"> <div class="block-inner"> <div class="content"> Drupal’s online documentation is © 2000-2024 by the individual contributors and can be used in accordance with the <a href="/terms">Creative Commons License, Attribution-ShareAlike 2.0</a>. PHP code is distributed under the <a href="https://www.gnu.org/licenses/old-licenses/gpl-2.0.html">GNU General Public License</a>. </div> </div> </div> <div id="block-drupalorg-crosssite-infra-partner" class="block block-drupalorg-crosssite"> <div class="block-inner"> <div class="content"> <a href="https://tag1consulting.com" >Infrastructure management for Drupal.org provided by <img src="/files/cta/graphic/tag1_wht.svg" alt="Tag1 logo" ></a> <br /> <span style="font-size: .65em;"><a href="https://d7es.tag1.com/">Need a Drupal 7 extended support partner? Consider Tag1.</a></span> </div> </div> </div> <div id="block-drupalorg-crosssite-drupalorg-footer" class="block block-drupalorg-crosssite"> <div class="block-inner"> <div class="content"> <h4 class="element-invisible">News items</h4><ul class="drupal-news"><li class="0 first"><a href="https://www.drupal.org/news">News</a></li> <li class="1"><a href="https://www.drupal.org/planet" title="News from Drupal community members">Planet Drupal</a></li> <li class="2"><a href="https://www.drupal.org/about/media-kit/social-media" title="Drupal on social media">Social media</a></li> <li class="3"><a href="https://www.drupal.org/subscribe">Sign up for Drupal news</a></li> <li class="4"><a href="https://www.drupal.org/security" title="Announcements from the Drupal Security Team">Security advisories</a></li> <li class="5 last"><a href="https://jobs.drupal.org/" title="Drupal Jobs">Jobs</a></li> </ul><h4 class="element-invisible">Our community</h4><ul class="community"><li class="0 first"><a href="https://www.drupal.org/community">Community</a></li> <li class="1"><span><a href="https://www.drupal.org/drupal-services" title="People and organizations offering Drupal services">Services</a>, <a href="https://www.drupal.org/training" title="People and organizations offering Drupal training">Training</a> & <a href="https://www.drupal.org/hosting" title="Organizations offering Drupal hosting">Hosting</a></span></li> <li class="2"><a href="https://www.drupal.org/community/contributor-guide">Contributor guide</a></li> <li class="3"><a href="https://groups.drupal.org/groups" title="groups.drupal.org">Groups & meetups</a></li> <li class="4"><a href="https://events.drupal.org" title="Upcoming and past DrupalCons">DrupalCon</a></li> <li class="5 last"><a href="https://www.drupal.org/dcoc" title="Drupal code of conduct">Code of conduct</a></li> </ul><h4 class="element-invisible">Documentation</h4><ul class="get-started"><li class="0 first"><a href="https://www.drupal.org/documentation" title="Documentation for working with Drupal">Documentation</a></li> <li class="1"><a href="https://www.drupal.org/docs">Drupal Guide</a></li> <li class="2"><a href="https://www.drupal.org/docs/user_guide/en/index.html">Drupal User Guide</a></li> <li class="3"><a href="https://www.drupal.org/documentation/develop">Developer docs</a></li> <li class="4 last"><a href="https://api.drupal.org/" title="Drupal API reference">API.Drupal.org</a></li> </ul><h4 class="element-invisible">Drupal code base</h4><ul class="download-extend"><li class="0 first"><a href="https://www.drupal.org/download">Download & Extend</a></li> <li class="1"><a href="https://www.drupal.org/project/drupal" title="Download the latest version of the Drupal software">Drupal core</a></li> <li class="2"><a href="https://www.drupal.org/project/project_module" title="Download add-on features and functionality">Modules</a></li> <li class="3"><a href="https://www.drupal.org/project/project_theme" title="Download pre-designed styles for Drupal">Themes</a></li> <li class="4 last"><a href="https://www.drupal.org/project/project_distribution" title="Download a pre-packaged Drupal site">Distributions</a></li> </ul><h4 class="element-invisible">Governance of community</h4><ul class="about"><li class="0 first"><a href="https://www.drupal.org/about">About</a></li> <li class="1"><a href="https://www.drupal.org/about/features/accessibility" title="Our committment to accessibility">Web accessibility</a></li> <li class="2"><a href="https://www.drupal.org/association" title="About the Drupal Association">Drupal Association</a></li> <li class="3"><a href="https://www.drupal.org/drupalorg" title="About Drupal.org">About Drupal.org</a></li> <li class="4"><a href="https://www.drupal.org/terms" title="Drupal.org terms of service">Terms of service</a></li> <li class="5 last"><a href="https://www.drupal.org/privacy" title="Drupal.org privacy policy">Privacy policy</a></li> </ul> </div> </div> </div> <div id="block-block-77" class="block block-block"> <div class="block-inner"> <div class="content"> <p>Drupal is a <a href="/about/trademark">registered trademark</a> of <a href="https://dri.es">Dries Buytaert</a>.</p> </div> </div> </div> </div> </div> <div class="region region-page-bottom"> <script type="text/javascript"> (function(){ window._pxAppId = 'PXVnPBBfwe'; window._pxParam2 = ''; window._pxParam3 = '0'; var p = document.getElementsByTagName('script')[0], s = document.createElement('script'); s.async = 1; s.src = '/VnPBBfwe/init.js'; p.parentNode.insertBefore(s,p); }()); </script> <noscript> <div style="position:fixed; top:0; left:0; display:none" width="1" height="1"> <img src="/VnPBBfwe/xhr/api/v1/collector/noScript.gif?appId=PXVnPBBfwe"> </div> </noscript> </div> <script type="text/javascript" src="/files/advagg_js/js__B0FBwiP97ZnD38IFraZus4upS4KVkMXI3ou0fJ2ZXGA__pPDESRJz9GHsxqQIwQ_V8xnFYEH5jipG2eicsfrdWCs__YaNGWokqa69Wq8hHbkE322PVJ8I-GmpfBsT8LGsMpcI.js" defer="defer"></script>    <script type="text/javascript" src="/files/advagg_js/js__79M6UrZjAw3oNGnUjsWip12JsvnUZmJGA3h9LI0kuzE__J0sbXAJNry2-C_ZL2xd0RdVuzwTLvwN-UisIv5RNCvU__YaNGWokqa69Wq8hHbkE322PVJ8I-GmpfBsT8LGsMpcI.js" defer="defer" onload="if(jQuery.isFunction(jQuery.holdReady)){jQuery.holdReady(true);}"></script>  <script type="text/javascript" src="/files/advagg_js/js__pqoYaVR8NVhof-vNXe50j2TKhFv__IihVag_h4G6kus__B4mbn4wICLQjWm1m3-z1kw8F1FtP0cDAHKp00Xy_-88__YaNGWokqa69Wq8hHbkE322PVJ8I-GmpfBsT8LGsMpcI.js" defer="defer"></script> <script type="text/javascript" src="/files/advagg_js/js__H5AFmq1RrXKsrazzPq_xPQPy4K0wUKqecPjczzRiTgQ__wor4r9P8YTtQ7p6fbywTetZ47Z_orumIfrrhgxrpLus__YaNGWokqa69Wq8hHbkE322PVJ8I-GmpfBsT8LGsMpcI.js" defer="defer" onload=" function advagg_mod_1() { // Count how many times this function is called. advagg_mod_1.count = ++advagg_mod_1.count || 1; try { if (advagg_mod_1.count <= 40) { init_drupal_core_settings(); // Set this to 100 so that this function only runs once. advagg_mod_1.count = 100; } } catch(e) { if (advagg_mod_1.count >= 40) { // Throw the exception if this still fails after running 40 times. throw e; } else { // Try again in 1 ms. window.setTimeout(advagg_mod_1, 1); } } } function advagg_mod_1_check() { if (window.init_drupal_core_settings && window.jQuery && window.Drupal) { advagg_mod_1(); } else { window.setTimeout(advagg_mod_1_check, 1); } } advagg_mod_1_check();"></script> <script type="text/javascript" src="/files/advagg_js/js__Oc0wwB7MVRfxtYw6EQM7d9sXj9PAQePoWSzQJ0uTk6c__iXqOGoaPhZHCPEspUr5BC8BwOx5P8B11xv7VOhoUii8__YaNGWokqa69Wq8hHbkE322PVJ8I-GmpfBsT8LGsMpcI.js" defer="defer"></script> <script type="text/javascript" src="/files/advagg_js/js__FabcJ6qluktliDejymsuV-FqaN_HyMKGe93c2rO9Ky0__el1ZLGkKneOoCS6OWa01WHuIEsTsXZ46MRLCF390Fbw__YaNGWokqa69Wq8hHbkE322PVJ8I-GmpfBsT8LGsMpcI.js" defer="defer"></script> <script type="text/javascript" src="/files/advagg_js/js__YT6D1B_BKxvm6JCH_t9sZNI5L6yITa_DlU5QcSlOkAU__OXobH7d1IP1o3WABlniIrU_-pcJacVSIPUv9bpD-6pQ__YaNGWokqa69Wq8hHbkE322PVJ8I-GmpfBsT8LGsMpcI.js" defer="defer"></script> <script type="text/javascript" src="/files/advagg_js/js__xNXZEl6CREO_N4cX50nXAG3o3PPW1f2SzBBHY8rEKV8__vTuPvw9kFyhvW1mq6Cl_PG3exxZo1gi4hMxmKe9QZUI__YaNGWokqa69Wq8hHbkE322PVJ8I-GmpfBsT8LGsMpcI.js" defer="defer"></script> <script type="text/javascript" src="/files/advagg_js/js__pLKQd4r7OrHglE7Qkqw53K2UXCqQdhqQ9v0cz7hMCQY__OErfYuQdGbFHcCoLoUW_ESSvaumApNojzjJit8-2xcw__YaNGWokqa69Wq8hHbkE322PVJ8I-GmpfBsT8LGsMpcI.js" defer="defer"></script> <script type="text/javascript" src="/files/advagg_js/js__hHUWFbMAa11eJtx5V0ym9o0YBsB1udk34qUT5wr1ihI__ntICfIdx3SsBpfvYB8AF0VuFk7gZjQgBaS1C9CyMj6o__YaNGWokqa69Wq8hHbkE322PVJ8I-GmpfBsT8LGsMpcI.js" defer="defer"></script> <script type="text/javascript"> <![CDATA[//><!]]> </script> <script type="text/javascript" src="/files/advagg_js/js__2k0CJ3KAQNFTFab3y6ZvNtxs3HLons0Brq7VwvPSkKo__RYlZCliQTuN7U7I5I1Xhn1dAop17g2hAft1wVGgKHGA__YaNGWokqa69Wq8hHbkE322PVJ8I-GmpfBsT8LGsMpcI.js" defer="defer"></script> <script type="text/javascript" src="/files/advagg_js/js__vj0LjvNwl-3K1P9LGT4BGuXCZcAovYsVlVmoJN3TMRg__KW8SiGceRY3sjIKVrffDjf2MK4A5Vp3EDDxVO-4pegI__YaNGWokqa69Wq8hHbkE322PVJ8I-GmpfBsT8LGsMpcI.js" defer="defer"></script> </body> </html>