WolfgangMehner/vim-plugins

Perl-Support: Extending the Perl/POD templates and menu

gllore opened this issue · 2 comments

Dear Wolfgang,

How about including some of the more general items in POD?
For example, I prefer to include the following at the start of my programs:

=head2 SYNOPSIS

PACKAGE NAME:

AUTHOR: Juan Lorenzo

DATE:

DESCRIPTION:
Version:

=head2 USE

=head3 NOTES

=head4 Examples

=head2 SYNOPSIS

=head3 SEISMIC UNIX NOTES

=head2 CHANGES and their DATES

=cut

THANKYOU!

Sorry for the long response time.

The new version of Perl-Support I just uploaded now includes "File Skeletons". You can specify the list of templates to be included if you create a new file.

Use the map \ntw or the menu entry Perl -> Snippets -> template setup wizard inside a Perl buffer and create a "template customization file". It will create an example file for you, that even includes your request as an example. Uncomment the property and the template to use it:

§ templates automatically included into new files
SetProperty ( 'Perl::FileSkeleton::Module', 'Comments.file description pm; ;Skeleton.module-pod; ;Skeleton.module-use' )

== Skeleton.module-pod == nomenu, below ==
=pod

=head2 SYNOPSIS

PACKAGE NAME: |BASENAME|

AUTHOR: |AUTHOR|

DATE: |DATE_PRETTY1|

DESCRIPTION:
Version:

=head2 USE

=cut
== ENDTEMPLATE ==


Alternatively, use can modify the customization file to create a new menu entry for the Perl -> POD sub-menu.

== POD.module documentation == below, map:pmd ==
=pod

...