{smcl}
{* *! version 2.1.3}{...}
{vieweralsosee "boilerplate" "help boilerplate"}{...}
{vieweralsosee "mkproject" "help mkproject"}{...}
{viewerjumpto "Syntax" "mkproject##syntax"}{...}
{viewerjumpto "Description" "mkproject##description"}{...}
{viewerjumpto "Example" "mkproject##example"}{...}
{title:Title}
{phang}
{bf:mkproject, create} {hline 2} Create new templates for the {cmd:mkproject} command.
{title:Description}
{pstd}To create a new template you are going to create a text file with two
parts:{p_end}
{pmore}a part within the {cmd:} and {cmd:} tags containing
meta-data, like a label, and{p_end}
{pmore}a part within the {cmd:} and {cmd:} tags containing the
actual steps you want {cmd:mkproject} to take when creating a new project.{p_end}
{pstd} After creating that file you type in Stata
{cmd:mkproject, create(}{it:that_text_file}{cmd:)}. Based on that text file
{cmd:mkproject} will create the template, and the corresponding help file.
{pstd}
This template is going to be used at three times when {cmd:mkproject} makes a
project folder:
{pmore}
First, {cmd:mkproject} creates the project folder, and any sub-folders specified
in the template. It changes the current working directory to the project folder.
{pmore}
Second, {cmd:mkproject} creates any files specified in the template, using
{help boilerplate}.
{pmore}
Third, {cmd:mkproject} executes any commands specified in the template.
{pstd}
So a template should tell {cmd:mkproject} what subdirectories it needs to create,
what files it needs to create, and what commands it needs to execute. On top of
that you can add various meta-data in the header.
{pstd}
Lets look at an example. Below is the template for {help mp_p_course:course}.
You can look at the source code for any template by typing {cmd:mkproject, query},
click on any template you are interested in, that opens a help-file, and at the
bottom there is a link that will show the source code for that template in the
viewer.
--------------- begin template -------------------
{cmd}{...}
project
2.1.2
docu
data
ana
txt
rlogc docu/research_log.md
main ana/_main.do
dta_c ana/_dta01.do
ana ana/_ana01.do
dirtree
{txt}{...}
-------------- end template --------------------
{pstd}
Lines between {cmd:} and {cmd:} contain
meta-information, like the label for that template.
{pstd}
Within the header you can add five types of meta-data:
{pmore}
{cmd:} Indicates that this is a template, and the word after it can
be either {cmd:project} or {cmd:boilerplate}, to indicate whether this is a
{cmd:mkproject} or {cmd:boilerplate} template. You can specify it in your text
file or if you don't specify it, {cmd:mkproject, create()} will add it for you.
{pmore}
{cmd:} Indicates which version of {cmd:mkproject} is used to create this
template. {cmd:mkproject} uses that information to ensure backwards compatability;
if a new version of {cmd:mkproject} becomes available, you can install that
without fearing that it will break your older templates. You can specify it
yourself, or if you don't specify it, {cmd:mkproject, create()} will set it to
the current version of {cmd:mkproject}
{pmore}
{cmd: