Welcome to the official home of the WordPress Documentation Team.

This team is responsible for coordinating all documentation initiatives around WordPress, including the handbooks and other general wordsmithing across the WordPress project.

Want to get involved?

Start here to find out more about what we do and how to contribute:

Onboarding to Documentation Team: An overview of what we do and how to collaborate
Documentation Issue Tracker on GitHub: Submit any Documentation Team-related issues on GitHubGitHub GitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/

Weekly meetings

Join our discussions of documentation issues here on the blog and on Slack.

The documentation team holds weekly office hours and monthly Contributor Days on each Tuesday of the month in the #docs SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. channel. It’s also where you can contact the team at any time outside meetings.

Style Guide

Home / Style Guide / Punctuation / Slashes

Slashes Edit

Topics

Slashes with combinations
Slashes with alternatives
Slashes with URLs
Slashes with file paths and names
Slashes with fractions and mathematical equations
Slashes with abbreviations
Slashes with dates

Note: Highlight: Avoid using slashes except in code examples, file paths, and URLs.

In general, try to avoid slashes in your documentation, except in code examples, file paths, and URLs.

Slashes with combinations

Use a slash to indicate a combination. Capitalize the second word if the first word in the combination is capitalized.

Examples

Tip: Recommended: Toggle the on/off switch on the dashboard.

Tip: Recommended: Toggle the On/Off switch on the dashboard.

Tip: Recommended: The UIUI UI is an acronym for User Interface - the layout of the page the user interacts with. Think ‘how are they doing that’ and less about what they are doing./UXUX UX is an acronym for User Experience - the way the user uses the UI. Think ‘what they are doing’ and less about how they do it. for the pluginPlugin A plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party was recently updated.

Tip: Recommended: The website can be developed with HTMLHTML HTML is an acronym for Hyper Text Markup Language. It is a markup language that is used in the development of web pages and websites./CSSCSS CSS is an acronym for cascading style sheets. This is what controls the design or look and feel of a site. as well.

Top ↑

Slashes with alternatives

Don’t use slashes to separate alternatives. Don’t substitute a slash for the words and or or.

Examples

Warning: Not recommended: You can install the pluginPlugin A plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party by uploading/searching in the directory.

Tip: Recommended: You can install the pluginPlugin A plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party by uploading it, or searching it in the directory.

Warning: Not recommended: The user must have administrator/editor access to publish the post.

Tip: Recommended: The user must have administrator or editor access to publish the post.

Tip: Recommended: The user must have administrator and editor access to publish the post.

Warning: Not recommended: Repeat the process 2/3 times until you get a favorable result.

Tip: Recommended: Repeat the process 2 or 3 times until you get a favorable result.

Tip: Recommended: Repeat the process 2 to 3 times until you get a favorable result.

Top ↑

Slashes with URLs

Use slashes in URLs, local, and internet addresses. Use two slashes after the protocol name.

Examples

Tip: Recommended: Navigate to http://localhost/wordpress to start the WordPress install.

Tip: Recommended: Visit https://make.wordpress.org/docs/style-guide/ for additional information.

Tip: Recommended: The uploaded file can be found on ftp://example.com/uploads.

Top ↑

Slashes with file paths and names

Use forward slashes in computer, server, folder, and file names and paths. For Microsoft Windows file paths and names, use backslashes.

Examples

Tip: Recommended: Download the zip file, and extract it into the web directory for your WAMP (Windows) installation: C:\wamp\www.

Tip: Recommended: Open the WordPress configuration file: /var/www/wordpress/wp-config.php.

Top ↑

Slashes with fractions and mathematical equations

Don’t use slashes with fractions, as they may be difficult to comprehend. Using slashes with fractions could be misunderstood as alternatives or combinations.

Examples

Warning: Not recommended: 3/4

Tip: Recommended: ¾

Tip: Recommended: 0.75

Tip: Recommended: 75%

Be cautious while using slashes between the numerator and denominator in mathematical equations.

Examples

Tip: Sometimes okay: x/2 = 4

Tip: Sometimes okay: (x+2)/8 = 2/3

Top ↑

Slashes with abbreviations

Don’t use abbreviations utilizing slashes. Instead, spell the abbreviation out.

Examples

Warning: Not recommended: b/c, w/o, w/, c/o, a/c

Tip: Recommended: because, without, with, care of, account

Top ↑

Slashes with dates

Don’t use date formats with slashes.

For more information, see Dates and times.

Last updated: April 5, 2021