PhpStorm 2016.3 Help

Generating and Updating Copyright Notice

In this section:

Prerequisite

Before using copyright profiles and generating copyright notices, make sure that the Copyright plugin is enabled. The plugin is bundled with PhpStorm and activated by default. If the plugin is not activated, enable it on the Plugins page of the Settings / Preferences Dialog as described in Enabling and Disabling Plugins.

Creating a Copyright profile from scratch

  1. Open the Settings / Preferences Dialog by pressing Ctrl+Alt+S or by choosing File | Settings for Windows and Linux or PhpStorm | Preferences for OS X. Expand the Editor node, and then click Copyright Profiles under Copyright. The Copyright Profiles page opens.
  2. Click the Add button /help/img/idea/2016.3/new.png on the toolbar in the Create new copyright profile dialog box that opens specify the name of the new profile and click OK. You return to the Copyright Profiles page where the new profile is added to the list of available copyright profiles.
  3. Specify the copyright notice to be generated. Do one of the following:
    • Type the desired plain text.
    • Define a Velocity template, then click the Validate button to check that the template has been specified correctly. Find the list of supported Velocity variables in the Copyright Profiles dialog box reference.
  4. In the Regexp to detect copyright in comments text box, type a character string to distinguish copyright notices from other comments during copyright update.

Creating a Copyright profile based on the settings of an existing profile

  1. Open the Settings / Preferences Dialog by pressing Ctrl+Alt+S or by choosing File | Settings for Windows and Linux or PhpStorm | Preferences for OS X. Expand the Editor node, and then click Copyright Profiles under Copyright. The Copyright Profiles page opens.
  2. Select the desired profile to inherit the settings from and click the Copy button /help/img/idea/2016.3/copyProfileButton.png on the toolbar.
  3. In the Create new copyright profile dialog box that opens specify the name of the new profile and click OK. You return to the Copyright Profiles page where the new profile is added to the list of available copyright profiles.
  4. View and edit the profile settings. Proceed as during creation of a profile from scratch.

Importing an existing Copyright notice text

  1. Open the Settings / Preferences Dialog by pressing Ctrl+Alt+S or by choosing File | Settings for Windows and Linux or PhpStorm | Preferences for OS X. Expand the Editor node, and then click Copyright Profiles under Copyright. The Copyright Profiles page opens.
  2. Click the Import button /help/img/idea/2016.3/importFromXML.png on the toolbar.
  3. In the dialog that opens, choose the location of the %.ipr% file that refers to the copyright profile with the desired notice definition.
  4. From the Choose profile to import list, that appears, select the desired copyright profile.
  5. In the Create new copyright profile dialog box that opens specify the name of the new profile and click OK. You return to the Copyright Profiles page where the new profile is added to the list of available copyright profiles.
  6. Proceed as during creation of a profile from scratch.

Discarding a Copyright profile

  1. Open the Settings / Preferences Dialog by pressing Ctrl+Alt+S or by choosing File | Settings for Windows and Linux or PhpStorm | Preferences for OS X. Expand the Editor node, and then click Copyright Profiles under Copyright. The Copyright Profiles page opens.
  2. Select the profile you want to discard and click the Delete button /help/img/idea/2016.3/delete.png on the toolbar.

Adding a Copyright notice

  1. Open the desired file in the editor.
  2. Press Alt+Insert.
  3. From the list that is displayed in the editor, choose Copyright.
  4. The following steps depend on the belonging of a file to a certain scope and the value of the Default project copyright field in the Copyright page.
    • If the file where you want to generate a copyright notice belongs to a certain scope, the copyright notice is generated according to the copyright profile settings.
    • If the field Default project copyright has the value No copyright and the file where you want to generate a copyright notice does not belong to any scope, PhpStorm prompts you to configure copyright settings:
      /help/img/idea/2016.3/copyright.png

      Click OK to open the Copyright page and configure the desired settings.

Note that if a file belongs to several scopes, these scopes are checked upside down. So doing, the first scope with this file is declared the proper one, and its copyright profile is used.

Updating a Copyright notice

  1. In the Project tool window, select files or directories where you want the copyright notice to be updated or just open the desired file in the editor.
  2. Right-click the selection, and choose Update Copyright on the context menu.

    To have copyright notices updated correctly, make sure that the keyword specified in the copyright profile is a part of the notice definition. Otherwise, PhpStorm will not detect copyright notices and, instead of updating existing notices, will insert new ones.

See Also

Reference:

Concepts:

Last modified: 1 December 2016