from resources.base import PROJECT
from features.base import FeatureDetails, Line
from features.templates.instructions import INSTRUCTIONS
from features.groups import Group


class TemplatesDetails(FeatureDetails):
    explains = 'The agent can start an item from a saved template. You can choose the template and edit the result.'
    name = "templates"
    group = Group.SHARED_RECORDS
    scope = PROJECT
    label = "Templates"
    when = "something is to be made from a template, or a template is written"

    title = "Templates"

    abstract = "Saved instructions and a starting outline for new items"

    help = """
        A template is written once and used for many resources. Its brief holds the
        instructions you read before working on anything made from it, and its parts are
        the skeleton a new resource starts with. applies_to says which types it is for; an empty
        list means any type.

        journal template create "<name>" --brief "<instructions>" --set applies_to=plan writes
        one, journal template section <n> "<part>" "<body>" adds to its skeleton.

        Anything is made from a template with --set template=<n> when it is created: it starts
        with the template's parts and links the template. A plan's parts become its phases, the
        part's text the phase's complete-when line, and a title ending in (checkpoint) marks a
        checkpoint. A template is refused for a type its applies_to leaves out.
    """

    lines = [
        Line(
            name=INSTRUCTIONS,
            title="template {{n}}, {{title}}: read before working on this",
            brief="{{brief}}",
        ),
    ]