From 75d1ec7bdc270b2a8c0b7a7b9cd2b6dc63f053d0 Mon Sep 17 00:00:00 2001 From: Toby Hodges Date: Mon, 18 Mar 2019 10:36:03 +0100 Subject: [PATCH] Add note about title casing to style guide --- _episodes/06-style-guide.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/_episodes/06-style-guide.md b/_episodes/06-style-guide.md index de38c82..968f803 100644 --- a/_episodes/06-style-guide.md +++ b/_episodes/06-style-guide.md @@ -183,4 +183,16 @@ Please label links with meaningful texts, in order to [improve accessibility](https://webaccess.berkeley.edu/ask-pecan/click-here). Please avoid `click here` or similar. +## Title Casing + +Lesson and episode titles should be written in title case e.g. + +> Saving the World, One Commit at a Time + +An exception should be made where the title includes the name of a tool/library/command that must be typed in lower case when used, e.g. + +> Data Visualisation with `matplotlib` + +(In HTML files, such as the workshop schedule and syllabus files in the [workshop webpage template](https://github.com/carpentries/workshop-template), tool/command/library names such as `matplotlib` in the example above can be correctly formatted using `` tags.) + {% include links.md %} -- GitLab