bigpresh / bigpresh/Pod-Readme

=begin text does not work as documented

Open
#16 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Perl
Stars
7
Forks
12
PR merge metrics
No merged PRs in 30d

Description

**perldoc Pod::Readme** says

```
You can also specify a block in another format:
=begin readme text
...
=end readme text

This will be translated into
=begin text
...
=end text
and will only be included in README files of that format.
```

I can't get any variation on that theme to produce output for text format.

I would like to select based on any output format - not just text. E.g. **=begin markdown** should output only if run with **_-f markdown_**.

Also, should there be an **=for readme text** variant? Like =for start/stop, this would allow other translators to include text common to doc and readme.

Here is a simple text case:

```
=pod

=begin text

This is text.

=end text

everywhere text.

=begin :readme

in readme

=begin text

nested text only readme

=end text

more readme

=end :readme

final

=cut

```

The results don't include any text in the **=begin text** blocks:

```
pod2readme -c -t readme -f text test.pod
everywhere text.

in readme

more readme

final

```

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.