filename_template/src/main/resources/META-INF/plugin.xml

103 lines
3.9 KiB
XML

<idea-plugin>
<id>de.idetools.filename_template</id>
<name>Filename Template</name>
<vendor email="filename_template@idetools.de" url="http://www.idetools.de/filename_template">IDE Tools</vendor>
<description><![CDATA[
<p>Create new files based on filename templates.</p>
<h3>Getting Started</h3>
<h4>Usage</h4>
<ol>
<li>Settings -> Tools -> Filename Template</li>
<li>Configure filename templates</li>
<li>Create new file: New -> <i>Template name</i></li>
<li>Complete the file name with return</li>
</ol>
<h4>Filename Template Configuration</h4>
<dl>
<dt>Active</dt>
<dd>Only active filename templates will be shown in the menu.</dd>
<dt>Name</dt>
<dd>The name will be shown in the menu.</dd>
<dt>Description</dt>
<dd>The description will be shown in the status bar when hovering the menu entry.</dd>
<dt>Template</dt>
<dd>
<p>The processed template where all place holders have been replaced with actual values is used as basis for the filename in the <i>New File</i> popup.</p>
<br/>
<p>A template might contain following place holders:</p>
<dl>
<dt>{DATE:FORMAT}</dt>
<dd>
The formatted date. If the format is omitted "yyyy-MM-dd" is used by default.<br />
See the java documentation for supported patterns: <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/time/format/DateTimeFormatter.html">Patterns for Formatting and Parsing</a>
</dd>
<dt>{EPOCH}</dt>
<dd>The current unix time stamp: Seconds since the Unix Epoch on January 1st, 1970 at UTC.</dd>
<dt>{HOST}</dt>
<dd>
The computers hostname.
</dd>
<dt>{PROJECT}</dt>
<dd>
The name of the current project.
</dd>
<dt>{USER}</dt>
<dd>
The username of the user running the IDE.
</dd>
<dt>{###}</dt>
<dd>
The first available sequential number. Define the initial value and desired leading zeros in the template.
Example: notes({042}).md => notes(042).md, notes(043).md, ...
</dd>
<dt>{|}</dt>
<dd>The caret position. If omitted the caret is positioned before the first '.' if available or at the end.</dd>
</dl>
</dd>
</dl>
<h3>Features</h3>
<ul>
<li>Manage filename templates</li>
<li>New File context menu integration</li>
</ul>
<p><small>Inspired by <a href="https://plugins.jetbrains.com/plugin/8144-configurablefilename">ConfigurableFilename</a></small></p>
]]></description>
<!-- please see https://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/plugin_compatibility.html
on how to target different products -->
<depends>com.intellij.modules.platform</depends>
<extensions defaultExtensionNs="com.intellij">
<applicationService
serviceImplementation="de.idetools.filename_template.settings.FilenameTemplateSettingsState"/>
<applicationConfigurable parentId="tools"
instance="de.idetools.filename_template.settings.FilenameTemplateConfigurable"
id="de.idetools.filename_template.settings.FilenameTemplateConfigurable"
displayName="Filename Template"/>
<backgroundPostStartupActivity
implementation="de.idetools.filename_template.InitializeFilenameTemplateActivity"/>
</extensions>
<actions>
<!-- Add your actions here -->
</actions>
</idea-plugin>