Conventions

In this book, you will find a number of text styles that distinguish between different kinds of information. Here are some examples of these styles and an explanation of their meaning.

Code words in text, database table names, folder names, filenames, file extensions, pathnames, dummy URLs, user input, and Twitter handles are shown as follows: "The \Drupal\Core\Url class provides static methods to generate an instance of itself, such as ::fromRoute()."

A block of code is set as follows:

  /**
   * {@inheritdoc}
   */
  public function alterRoutes(RouteCollection $collection) {
if ($route = $collection->get('mymodule.mypage)) {
      $route->setPath('/my-page');
    }
  }

When we wish to draw your attention to a particular part of a code block, the relevant lines or items are set in bold:

  /**
   * {@inheritdoc}
   */
  public function alterRoutes(RouteCollection $collection) {
if ($route = $collection->get('mymodule.mypage)) {
      $route->setPath('/my-page');
    }
  }

Any command-line input or output is written as follows:

$ php core/scripts/run-tests.sh PHPUnit

New terms and important words are shown in bold. Words that you see on the screen, for example, in menus or dialog boxes, appear in the text like this: "Clicking the Next button moves you to the next screen."

Note

Warnings or important notes appear in a box like this.

Tip

Tips and tricks appear like this.