function example_profile_details

Return a description of the profile for the initial installation screen.

Return value

An array with keys 'name' and 'description' describing this profile, and optional 'language' to override the language selection for language-specific profiles.

File

external_documentation/developer/example.profile, line 25

Code

function example_profile_details() {
    return array(
        // These two strings will be displayed on the initial profile-selecion
        // page, as a radio-button label, and description below. Because the
        // page is shown before language selection, there's no point to attempt
        // translation in any way; it's always shown in English. But however,
        // if the profile is focused to install Drupal in some other language,
        // these strings may be provided in that language, assuming that the
        // maintainer of the installed new Drupal site understands that better.
        // To skip the untranslatable profile-selection page entirely, ensure
        // that there's just one profile available, by deleting the default
        // profile.
'name' => 'Example installation profile',
        'description' => 'This is an example installation profile for Drupal 6.x, demonstrating some of the principles to developers.',
        // This example profile is supposed to be language-focused, so we
        // inject the language selection here, hiding the language selection
        // screen from the user, and so saving one unnecessary, untranslatable
        // step. Any profile focused to features rather than language, or
        // expecting more languages to choose from, should omit the line below.
        // We're using Czech as an example here; it only works if a valid file
        // cs.po (with installer translations) is provided in the
        // profiles/example/translations directory, otherwise default English
        // will be used instead.
'language' => 'cs',
    );
}