diff --git a/docs/source/images/fig_story_structure_manuscript.png b/docs/source/images/fig_story_structure_manuscript.png new file mode 100644 index 00000000..01351ec9 Binary files /dev/null and b/docs/source/images/fig_story_structure_manuscript.png differ diff --git a/docs/source/project_story.rst b/docs/source/writing_story.rst similarity index 68% rename from docs/source/project_story.rst rename to docs/source/writing_story.rst index 461efca2..91d9581a 100644 --- a/docs/source/project_story.rst +++ b/docs/source/writing_story.rst @@ -1,8 +1,8 @@ -.. _a_story: +.. _a_story_structure: -*************** -Story Structure -*************** +************************ +Story Structure Comments +************************ .. _The Story Grid: https://storygrid.com @@ -11,14 +11,20 @@ As of version 2.7, story structure annotations using the ``%story`` style of com To use the feature, make the first word of a comment ``story``, followed by a period, a structure term, a colon, a space and the text for that term. -Here's and example: +Here's an example: .. code-block:: md %story.term: text -The term can be anything that you want to track in the manuscript. This construct is intended to -make it easier to extract metadata from a work to perform a structural analysis of the story. +.. versionadded:: 2.7 + + +Usage +===== + +The story term can be anything that you want to track in the manuscript. This construct is intended +to make it easier to extract metadata from a work to perform a structural analysis of the story. There are probably as many ways to examine story structure as there are authors and editors combined. For this reason the story tag is flexible. You can use any terms you want and track any @@ -31,7 +37,10 @@ their fear of giving a speech as: .. code-block:: md + ### Scene + %Synopsis: Carol overcomes her fear of giving a speech. + %Story.incite: Carol is pleased to be invited to a conference to see her boss deliver a keynote. %Story.complication: Carol's boss calls in sick and asks her to deliver a big speech. %Story.crisis: Carol has a fear of appearing on stage. @@ -43,6 +52,20 @@ track any element of a scene. Some examples include time of day, how much time p or even the physical form of a shape-shifting character. If a story involves magic, one could track which wand a main character has in hand. It's up to tha author. -When the story and other scene metadata is extracted into a tabluar form, it is possible to get a +When the story and other scene metadata is extracted into a tabular form, it is possible to get a comprehensive overview of the story and to identify possible issues. For example, so many fast-paced scenes without a break that readers might become fatigued or over-stimulated. + + +Output +====== + +The story structure comments can be included in the manuscript, and are formatted similarly to +the synopsis comments: + +.. figure:: images/fig_story_structure_manuscript.png + + A set of story structure comments as shown in the Manuscript tool. + +When you export your project data from the Outline View, all story structure terms are added as +columns to the exported file, which can then be opened in the spread sheet software of your choice.