File perl-Pod-WikiDoc.spec of Package perl-Pod-WikiDoc

Overview Repositories Revisions Requests Users Attributes Meta

File perl-Pod-WikiDoc.spec of Package perl-Pod-WikiDoc

#
# spec file for package perl-Pod-WikiDoc
#
# Copyright (c) 2019 SUSE LINUX GmbH, Nuernberg, Germany.
#
# All modifications and additions to the file contributed by third parties
# remain the property of their copyright owners, unless otherwise agreed
# upon. The license for this file, and modifications and additions to the
# file, is the same license as for the pristine package itself (unless the
# license for the pristine package is not an Open Source License, in which
# case the license is the MIT License). An "Open Source License" is a
# license that conforms to the Open Source Definition (Version 1.9)
# published by the Open Source Initiative.

# Please submit bugfixes or comments via https://bugs.opensuse.org/
#

Name:           perl-Pod-WikiDoc
Version:        0.21
Release:        0
%define cpan_name Pod-WikiDoc
Summary:        Generate Pod from inline wiki style text
License:        Apache-2.0
Group:          Development/Libraries/Perl
Url:            https://metacpan.org/release/%{cpan_name}
Source0:        https://cpan.metacpan.org/authors/id/D/DA/DAGOLDEN/%{cpan_name}-%{version}.tar.gz
BuildArch:      noarch
BuildRoot:      %{_tmppath}/%{name}-%{version}-build
BuildRequires:  perl
BuildRequires:  perl-macros
BuildRequires:  perl(File::pushd)
BuildRequires:  perl(Getopt::Lucid) >= 0.14
BuildRequires:  perl(IO::String) >= 1.06
BuildRequires:  perl(IPC::Run3) >= 0.033
BuildRequires:  perl(Parse::RecDescent) >= 1.967006
BuildRequires:  perl(Probe::Perl) >= 0.01
Requires:       perl(File::pushd)
Requires:       perl(Getopt::Lucid) >= 0.14
Requires:       perl(IO::String) >= 1.06
Requires:       perl(Parse::RecDescent) >= 1.967006
%{perl_requires}

%description
Pod works well, but writing it can be time-consuming and tedious. For
example, commonly used layouts like lists require numerous lines of text to
make just a couple of simple points. An alternative approach is to write
documentation in a wiki-text shorthand (referred to here as _wikidoc_) and
use Pod::WikiDoc to extract it and convert it into its corresponding Pod as
a separate '.pod' file.

Documentation written in wikidoc may be embedded in Pod format blocks, or,
optionally, in specially marked comment blocks. Wikidoc uses simple
text-based markup like wiki websites to indicate formatting and links. (See
WIKIDOC MARKUP, below.)

Pod::WikiDoc processes text files (or text strings) by extracting both
existing Pod and wikidoc, converting the wikidoc to Pod, and then writing
the combined document back to a file or standard output.

Summary of major features of Pod::WikiDoc:

* Extracts and converts wikidoc from Pod format blocks or special wikidoc
comment blocks

* Extracts and preserves existing Pod

* Provides bold, italic, code, and link markup

* Substitutes user-defined keywords

* Automatically converts special symbols in wikidoc to their Pod escape
equivalents, e.g. E<lt>, E<gt>

* Preserves other Pod escape sequences, e.g. E<euro>

In addition, Pod::WikiDoc provides a command-line utility, wikidoc, to
simplify wikidoc translation.

See the Pod::WikiDoc::Cookbook for more detailed usage examples, including
how to automate '.pod' generation when using Module::Build.

%prep
%setup -q -n %{cpan_name}-%{version}

%build
perl Makefile.PL INSTALLDIRS=vendor
make %{?_smp_mflags}

%check
make test

%install
%perl_make_install
%perl_process_packlist
%perl_gen_filelist

%files -f %{name}.files
%defattr(-,root,root,755)
%doc Changes CONTRIBUTING.mkdn examples README Todo
%license LICENSE

%changelog

Places

File perl-Pod-WikiDoc.spec of Package perl-Pod-WikiDoc

Places