Add Gwen’s initial guidance about formatting

This is based on some work Gwen did for Civil Service Digital. Let’s
get it in for now so that we have a starting point from which to
improve.

This specifically doesn’t reference ‘optional’ placeholders because I
don’t know how best to explain those yet.
This commit is contained in:
Chris Hill-Scott
2016-07-14 16:52:53 +01:00
parent ee52e72f90
commit bc715b3dd8
4 changed files with 41 additions and 9 deletions

View File

@@ -0,0 +1,27 @@
<h2 class="heading-medium">Formatting</h2>
<p>
To put a title in your template, use a hash:
</p>
<div class="panel panel-border-wide">
<p>
# This is a title
</p>
</div>
<p>
To make bullet points, use asterisks:
</p>
<div class="panel panel-border-wide">
<p>
* point 1<br/>
* point 2<br/>
* point 3<br/>
</p>
</div>
<p>
To add a callout, use a caret:
</p>
<div class="panel panel-border-wide">
<p>
^ You must tell us if your circumstances change
</p>
</div>

View File

@@ -2,3 +2,8 @@
<p>
Always use full URLs, starting with https://
</p>
<div class="panel panel-border-wide">
<p>
Apply now at https://www.gov.uk/example
</p>
</div>

View File

@@ -2,11 +2,10 @@
Personalisation
</h2>
<p>
Use double brackets to add personalisation.
</p>
<p>
Correct: ((name))
</p>
<p>
Incorrect: ((Helen))
Use double brackets to personalise your message:
</p>
<div class="panel panel-border-wide">
<p>
Hello ((first name)), your reference is ((ref number))
</p>
</div>

View File

@@ -14,11 +14,11 @@
<form method="post">
<div class="grid-row">
<div class="column-two-thirds">
<div class="column-three-quarters">
{{ textbox(form.name, width='1-1', hint='Your recipients wont see this', rows=10) }}
{{ textbox(form.subject, width='1-1', highlight_tags=True, rows=2) }}
</div>
<div class="column-two-thirds">
<div class="column-three-quarters">
{{ textbox(form.template_content, highlight_tags=True, width='1-1', rows=8) }}
{{ page_footer(
'Save',
@@ -27,6 +27,7 @@
) }}
</div>
<aside class="column-whole">
{% include "partials/templates/guidance-formatting.html" %}
{% include "partials/templates/guidance-personalisation.html" %}
{% include "partials/templates/guidance-links.html" %}
</aside>