From f6783a32887608e5252e1223867a2fca9b3ec540 Mon Sep 17 00:00:00 2001 From: Rob Date: Fri, 19 Feb 2016 20:28:48 +0000 Subject: [PATCH] Change 'Complex' theme to 'Puzzle theme' which makes it much easier to remember at-a-glance: MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Remove card #02 on 'Complex theme' and rename 'Puzzle theme' - Remove following fields from the renamed 'Complex theme': - Remove '✔ What does this syntax do?' field, as well as removing: - ----✄-- Hide on front: Syntax (inline code) - »»♻»» Show as reference: Syntax (inline code) - ----✄-- Hide on front: Sample (code block or image) - »»♻»» Show as reference: Sample (code block or image) - Rename fields including »»♻»» to »»♻«« and reset the card templates - Easier to understand documentation for the themes (I hope) - Change a few README urls --- README.md | 6 +- dist/deck/README.md | 2 +- dist/themes/README.md | 51 ++++++++-------- dist/themes/assets/README.md | 14 ++++- dist/themes/assets/css/README.md | 4 +- dist/themes/complex/card-02.html | 59 ------------------- dist/themes/{complex => puzzle}/card-01.html | 2 +- .../card-03.html => puzzle/card-02.html} | 10 ++-- dist/themes/simple/card-02.html | 8 +-- 9 files changed, 55 insertions(+), 101 deletions(-) delete mode 100644 dist/themes/complex/card-02.html rename dist/themes/{complex => puzzle}/card-01.html (98%) rename dist/themes/{complex/card-03.html => puzzle/card-02.html} (88%) diff --git a/README.md b/README.md index ac73f59..6e1345d 100644 --- a/README.md +++ b/README.md @@ -11,13 +11,13 @@ The template is built in html and css, with [syntax highlighting](./dist/themes/ ## Card Types -There are currently two types of card, a simple card and a complex card. Both share the `dist/themes/assets/css/main.css` file. +There are currently two types of card, a simple card and a puzzle card. Both share the `dist/themes/assets/css/main.css` file. 1. **[Simple](./dist/themes/README.md)** - What's the answer? - What does this syntax do? -2. **[Complex](./dist/themes/README.md#complex-theme)** - - Everything in **Simple** theme +2. **[Puzzle](./dist/themes/README.md#puzzle-theme)** + - What's the answer? - **+** Puzzle question diff --git a/dist/deck/README.md b/dist/deck/README.md index 34383a2..0a11e27 100644 --- a/dist/deck/README.md +++ b/dist/deck/README.md @@ -3,7 +3,7 @@ - [Home](../../README.md) - **THEME** - [Simple Anki theme](../themes/README.md#simple-theme) - - [Complex Anki theme](../themes/README.md#complex-theme) + - [Puzzle Anki theme](../themes/README.md#puzzle-theme) - **Deck example** - [Notes](../themes/README.md#notes) - **THEME COLOURS** diff --git a/dist/themes/README.md b/dist/themes/README.md index e99a65b..a9b8af0 100644 --- a/dist/themes/README.md +++ b/dist/themes/README.md @@ -3,7 +3,7 @@ - [Home](../../README.md) - **THEME** - [Simple Anki theme](#simple-theme) - - [Complex Anki theme](#complex-theme) + - [Puzzle Anki theme](#puzzle-theme) - [Deck example](../deck/README.md) - [Notes](#notes) - **THEME COLOURS** @@ -12,23 +12,17 @@ -## Simple theme +## Card #01 (shared) +### Simple theme +### Puzzle theme -Both the **Simple theme** and **[Complex theme](#complex-theme)** share the same basic fields. This content will be used to output two cards: +Both the **Simple theme** and **[Puzzle theme](#puzzle-theme)** share the *'What's the answer?'* fields and card: 1. **What's the answer?** - What does the following code do? - How can we use the syntax examples and what would be the result? -2. **What does this syntax do?** - - Ask another question about the code sample, or - - Drill on the specific uses for the function, or - - Remember the syntax: - - What function or method is this? - - And what will it achieve? - -## Card 01: What's the answer? (Fields 1-6) -**Key:** ★ Required / ☆ Optional (recommended) +> **Key:** ★ Required / ☆ Optional (recommended) #### ★ Title @@ -64,8 +58,19 @@ Both the **Simple theme** and **[Complex theme](#complex-theme)** share the same - For any key functions or symbols, wrap in ``. -## Card 02: What does this syntax do? (Fields 7-11) -**Key:** ✔ Optional / ✄ Optional (explicitly *hide* fields) / ♻ Optional (explicity *show* fields) +## Card #02 +### Simple theme + +The simple theme introduces a way to add a *syntax reminder* question: + +2. **What does this syntax do?** + - Ask another question about the code sample, or + - Drill on the specific uses for the function, or + - Remember the syntax: + - What function or method is this? + - And what will it achieve? + +> **Key:** ✔ Optional / ✄ Optional (explicitly *hide* fields) / ♻ Optional (explicity *show* fields) #### ✔ What does this syntax do? @@ -78,7 +83,7 @@ Both the **Simple theme** and **[Complex theme](#complex-theme)** share the same - Simply enter any text to hide field, i.e. `true`. - Great for questions that force you to remember the syntax, where you don't want any giveaways. -#### »»♻»» Show as reference: Syntax (inline code) +#### »»♻«« Show as reference: Syntax (inline code) - Optionally show the [inline code sample](#☆-syntax-inline-code) - Simply enter any text to hide field, i.e. `true`. @@ -90,7 +95,7 @@ Both the **Simple theme** and **[Complex theme](#complex-theme)** share the same - Simply enter any text to hide field, i.e. `true`. - Depending on the sample code, you may want to hide this if it makes the answer too obvious. -#### »»♻»» Show as reference: Sample (code block or image) +#### »»♻«« Show as reference: Sample (code block or image) - Optionally show the main [sample code block](#☆-sample-code-block-or-image) - Simply enter any text to hide field, i.e. `true`. @@ -100,19 +105,17 @@ Both the **Simple theme** and **[Complex theme](#complex-theme)** share the same ----- -## Complex theme - - +## Card #02 +### Puzzle theme -The complex theme extends the [Simple theme](#simple-theme) to allow us to get a little creative. +The puzzle theme extends the *'What's the answer?'* fields (shared with the [Simple theme](#simple-theme)) to allow us to get a little creative. -1. **Puzzle question** +2. **Puzzle question** - Drill yourself in a different way. - Try a different result with the syntax you're learning. - Add a new function to the mix. -## Card 03: Puzzle question (Fields 12-21) -**Key:** ♞ Required / ✄ Optional (explicitly *hide* fields) / ♻ Optional (explicity *show* fields) / ♘ Optional (Only if ✄ is used) +> **Key:** ♞ Required / ✄ Optional (explicitly *hide* fields) / ♻ Optional (explicity *show* fields) / ♘ Optional (Only if ✄ is used) #### ♞ Puzzle @@ -170,7 +173,7 @@ The complex theme extends the [Simple theme](#simple-theme) to allow us to get a #### ✎ Other notes -Use sparingly, as it's always best to be succinct with Anki. Simple is easier to remember than complex, so think of this as more of a 'reference' for future use. +Use sparingly, as it's always best to be succinct with Anki. Simple is easier to remember than puzzle, so think of this as more of a 'reference' for future use. - Links to documentation - Supplementary notes diff --git a/dist/themes/assets/README.md b/dist/themes/assets/README.md index b2c08b1..3a43852 100644 --- a/dist/themes/assets/README.md +++ b/dist/themes/assets/README.md @@ -1,6 +1,16 @@ # Anki theme: Styles ## Tomorrow light and Monokai +- [Home](../../../README.md) + - **THEME** + - [Simple Anki theme](../../README.md#simple-theme) + - [Puzzle Anki theme](../../README.md#puzzle-theme) + - [Deck example](../../../deck/README.md) + - [Notes](../../README.md#notes) + - **THEME COLOURS** + - [Basic highlighting](../css/README.md) + - [Automatic highlighting](../css/README.md#automatic-syntax-highlighting-with-highlightjs) + ### Less I'm using `Less` to generate the `main.css` file from `src/assets/less/main.less` — refer to code and comments there. Quickly change the colour scheme by changing or creating your own variables in `src/assets/less/theme.less` and recompiling the css file. @@ -61,7 +71,7 @@ You can also specify a language: 5. Copy and paste into `Key point (code block or image)` or `Puzzle answer (code block or image)` fields - Including everything from `
` to `
` -It's wise to keep a backup for easy editing, so I've added a `Markdown` field in both the [Simple](../../simple/README.md) and [Complex](../../complex/README.md) themes — here you can store raw markdown or a link to the original code (Github gist for example). +It's wise to keep a backup for easy editing, so I've added a `Markdown` field in both the [Simple](../../simple/README.md) and [Puzzle](../../puzzle/README.md) themes — here you can store raw markdown or a link to the original code (Github gist for example). ### Changing the theme: @@ -76,7 +86,7 @@ It's wise to keep a backup for easy editing, so I've added a `Markdown` field in - [Anki Themes](../../../README.md) - [Simple Anki theme](../../simple/README.md) -- [Complex Anki theme](../../complex/README.md) +- [Puzzle Anki theme](../../puzzle/README.md) - [Deck example](../../../dist/deck/README.md) diff --git a/dist/themes/assets/css/README.md b/dist/themes/assets/css/README.md index 7f9fa34..51a2c61 100644 --- a/dist/themes/assets/css/README.md +++ b/dist/themes/assets/css/README.md @@ -4,7 +4,7 @@ - [Home](../../../../README.md) - **THEME** - [Simple Anki theme](../../README.md#simple-theme) - - [Complex Anki theme](../../README.md#complex-theme) + - [Puzzle Anki theme](../../README.md#puzzle-theme) - [Deck example](../../../dist/deck/README.md) - [Notes](../README.md#notes) - **THEME COLOURS** @@ -53,7 +53,7 @@ Styling our code with HTML5 tags is pretty efficient with the Anki wysiwyg, but 3. Copy and paste into any `* (code block or image)` field: - Including everything from `
` to `
`. -It's wise to keep a backup for easy editing, so I've added a `✎ Markdown` field in both the **Simple** and **Complex** themes — here you can store raw markdown or a link to the original code (Github gist for example). +It's wise to keep a backup for easy editing, so I've added a `✎ Markdown` field in both the **Simple** and **Puzzle** themes — here you can store raw markdown or a link to the original code (Github gist for example). #### Disable highlighting diff --git a/dist/themes/complex/card-02.html b/dist/themes/complex/card-02.html deleted file mode 100644 index 5a10eae..0000000 --- a/dist/themes/complex/card-02.html +++ /dev/null @@ -1,59 +0,0 @@ - - -{{#✔ What does this syntax do?}} -
-

- {{^☆ Syntax}}Syntax{{/☆ Syntax}} - {{#☆ Syntax}}{{☆ Syntax}}{{/☆ Syntax}} - - {{^----✄-- Hide on front: Syntax (inline code)}} - {{☆ Syntax (inline code)}} - {{/----✄-- Hide on front: Syntax (inline code)}} -

- {{^----✄-- Hide on front: Sample (code block or image)}} -
- {{☆ Sample (code block or image)}} -
- {{/----✄-- Hide on front: Sample (code block or image)}} -

{{✔ What does this syntax do?}}

-
-{{/✔ What does this syntax do?}} - - - -{{FrontSide}} - -
-
{{★ Key point (code block or image)}}
-
{{★ Key point notes}}
-
- {{#»»♻»» Show as reference: Syntax (inline code)}} -
-

Original syntax: - {{☆ Syntax (inline code)}} -

-
- {{/»»♻»» Show as reference: Syntax (inline code)}} - {{#»»♻»» Show as reference: Sample (code block or image)}} -
-

Original sample code:

- {{☆ Sample (code block or image)}} -
- {{/»»♻»» Show as reference: Sample (code block or image)}} -
-
- {{#✎ Other notes}}{{✎ Other notes}}{{/✎ Other notes}} -
-
diff --git a/dist/themes/complex/card-01.html b/dist/themes/puzzle/card-01.html similarity index 98% rename from dist/themes/complex/card-01.html rename to dist/themes/puzzle/card-01.html index d0fea42..eed207b 100644 --- a/dist/themes/complex/card-01.html +++ b/dist/themes/puzzle/card-01.html @@ -1,5 +1,5 @@