| 1 | package App::Framework::Feature::Data ; | ||
| 2 | |||
| 3 | =head1 NAME | ||
| 4 | |||
| 5 | App::Framework::Feature::Data - Handle application setup data | ||
| 6 | |||
| 7 | =head1 SYNOPSIS | ||
| 8 | |||
| 9 | # Data feature is loaded by default as if the script contained: | ||
| 10 | use App::Framework '+Data' ; | ||
| 11 | |||
| 12 | |||
| 13 | =head1 DESCRIPTION | ||
| 14 | |||
| 15 | System feature that provides the application core with access to the setup information stored | ||
| 16 | in the __DATA__ section. | ||
| 17 | |||
| 18 | The __DATA__ section at the end of the script is used by the application framework to allow the script developer to define | ||
| 19 | various settings for his/her script. This setup is split into "headed" sections of the form: | ||
| 20 | |||
| 21 | [ <section name> ] | ||
| 22 | |||
| 23 | <settings> | ||
| 24 | |||
| 25 | In general, the <section name> is the name of a field value in the application, and <settings> is some text that the field will be set to. Sections | ||
| 26 | of this type are: | ||
| 27 | |||
| 28 | =over 4 | ||
| 29 | |||
| 30 | =item B<[SUMMARY]> - Application summary text | ||
| 31 | |||
| 32 | A single line summary of the application. Used for man pages and usage summary. | ||
| 33 | |||
| 34 | (Stored in the application's I<summary> field). | ||
| 35 | |||
| 36 | =item B<[DESCRIPTION]> - Application description text | ||
| 37 | |||
| 38 | Multiple line description of the application. Used for man pages. | ||
| 39 | |||
| 40 | (Stored in the application's I<description> field). | ||
| 41 | |||
| 42 | =item B<[SYNOPSIS]> - Application synopsis [I<optional>] | ||
| 43 | |||
| 44 | Multiple line synopsis of the application usage. By default the application framework creates this if it is not specified. | ||
| 45 | |||
| 46 | (Stored in the application's I<synopsis> field). | ||
| 47 | |||
| 48 | =item B<[NAME]> - Application name [I<optional>] | ||
| 49 | |||
| 50 | Name of the application usage. By default the application framework creates this if it is not specified. | ||
| 51 | |||
| 52 | (Stored in the application's I<name> field). | ||
| 53 | |||
| 54 | =back | ||
| 55 | |||
| 56 | __DATA__ sections that have special meaning are: |