Merge branch 'dev' into view_details

2020-05-28 19:34:22 +02:00
parent 4f7d144163 9682c4756c
commit 3704956112
41 changed files with 358 additions and 242 deletions
@@ -0,0 +1,6 @@
+%%~ 14298de4d9524:f7e2d9f330615:f6622b4617424:John Smith
+# John Smith
+
+@tag: John
+
+He’s pretty cool. Not Brad Pitt though.
@@ -0,0 +1,6 @@
+%%~ 53b69b83cdafc:7031beac91f75:Title Page
+# My Novel
+
+**By Jane Doh**
+
+It’s also possible to add some text on this page.
@@ -0,0 +1,6 @@
+%%~ 5eaea4e8cdee8:15c4492bd5107:Mars
+# Mars
+
+@tag: Mars
+
+It’s red. Dusty and red.
@@ -0,0 +1,22 @@
+%%~ 636b6aa9b697b:e7ded148d6e4a:7031beac91f75:Making a Scene
+### Making a Scene
+
+@pov: Jane
+@char: John
+@location: Earth
+
+A scene is defined by a level three heading, like the one at the top of this page. The scene will be assigned to the chapter preceding it in the project tree.
+
+Each paragraph in the scene is separated by a blank line. The text supports minimal formatting, like **bold**, _italic_ and  __underscore__.
+
+In addition, the editor supports automatic formatting of “quotes”, both double and ‘single’. Depending on the syntax highlighter, these can be in different colours.
+
+If you have the need for it, you can also add text that can be automatically replaced by other text when you generate a preview or export the project. Now, let’s auto-replace this A with <A>, and this C with <C>.  While <E> is just <E>. Press Ctrl+R to see what this looks like in the view pane.
+
+The editor also supports non breaking spaces, and the spell checker accepts long dashes—like this—as valid word separators.
+
+#### Some Section Here
+
+If you need to split a scene file up into further pieces, you can do so with the level four heading, like above. This is referred to as a section.
+
+Both scene and section titles can be left out of the final exported document. The formatting of titles can be selected from the export dialog.
@@ -0,0 +1,8 @@
+%%~ 6a2d6d5f4f401:e7ded148d6e4a:7031beac91f75:Chapter One
+## So it Begins
+
+@pov: Jane
+@location: Earth
+
+% Synopsis: We can add a chapter file, but keep the scene files separate. In the chapter file we can set the meta data that applies to the whole chapter if we wish to.
+
@@ -0,0 +1,14 @@
+%%~ 88706ddc78b1b:e7ded148d6e4a:7031beac91f75:Chapter Two
+## Where has John Gone?
+
+@pov: Jane
+@location: Space
+
+% Further chapters can be added by adding another chapter file. This time we can add a quick scene in the same file to introduce it.
+
+### Jane Cannot Find John
+
+@pov: Jane
+@location: Space
+
+Jane has been looking all over for John. He’s nowhere to be found on Earth, so Jane goes to space.
@@ -0,0 +1,20 @@
+%%~ 96b68994dfa3d:e7ded148d6e4a:7031beac91f75:A Note on Structure
+# A Note on Structure
+
+This file is just a note. You can save notes anywhere you like in the project tree. Notes can be filtered out when you export the project.
+
+In root folders that isn’t the Novel root folder, you can _only_ add notes. In the Novel root folder, you can choose between a number of layouts. Some of them are just to let yourself know what each file is for.
+
+## Headers in Notes
+
+Unlike in novel files, headers in notes have no particular meaning other than visual aids for you, and for correct formatting in the export or view pane.
+
+## Folders in the Tree View
+
+The folders in the tree view have no structural meaning other than they’re a way for you to organise your files into groups in whatever way suits you. They are not intended to represent chapters, but you can of course use them for that. If you do, know that you still need to define chapter headers in your structure so novelWriter knows where you want them.
+
+## Linking Files and Notes
+
+You can link files and notes together by assigning tags to them, and then reference them from other files. The file class of a file determines which reference keywords apply to each file. For instance a file in the Characters root folder can be referenced using either the @char keyword or the @pov keyword.
+
+If you want to see the content of the file the reference points to, you can click Ctrl+Enter with the cursor on top of the reference, and the view pane will show you the file. In the view pane, all references are clickable, so you can navigate further. At the bottom of the view pane, a list of files referencing the one your viewing will appear. This panel updates when you navigate, unless you make it sticky by clicking the sticky checkbox.
@@ -0,0 +1,4 @@
+%%~ 974e400180a99:7031beac91f75:Page
+This is a plain page with some text on it.
+
+This file should receive no special formatting, but the text will always be left aligned and the content will always start on a fresh page when the project is exported.
@@ -0,0 +1,7 @@
+%%~ ae7339df26ded:e7ded148d6e4a:7031beac91f75:We Found John!
+### We Found John!
+
+@pov: John
+@location: Mars, OuterSpace
+
+Jane has been searching for a while, and she finally found John on Mars. He was indeed in space! What was he doing on Mars anyway? Well, it turns out, he was farming potatoes.
@@ -0,0 +1,6 @@
+%%~ b3e74dbc1f584:15c4492bd5107:Earth
+# Earth
+
+@tag: Earth
+
+Third planet from the sun, fairly dense, and with lots of people on it.
@@ -0,0 +1,4 @@
+%%~ b8136a5a774a0:7031beac91f75:Delete Me!
+### Delete Me!
+
+This scene is trash.
@@ -0,0 +1,20 @@
+%%~ ba8a28a246524:e7ded148d6e4a:7031beac91f75:Interlude
+## Interlude
+
+% Notice that this is a file with the flag ‘N.Un’. The ‘N’ means it’s a novel file, and the ‘Un’ means it’s an unnumbered chapter. Unnumbered chapters can be treated separately from numbered chapters during export. Perfect for when you want to add an interlude, or for a prologue or epilogue.
+
+I am the very model of a modern Major-General  
+I've information vegetable, animal, and mineral  
+I know the kings of England, and I quote the fights historical  
+From Marathon to Waterloo, in order categorical
+
+I'm very well acquainted, too, with matters mathematical  
+I understand equations, both the simple and quadratical  
+About binomial theorem I'm teeming with a lot o’ news  
+With many cheerful facts about the square of the hypotenuse
+
+	With many cheerful facts about the square of the hypotenuse  
+	With many cheerful facts about the square of the hypotenuse  
+	With many cheerful facts about the square of the hypotepotenuse
+
+% Notice that the lines in the verse have highlighted spaces at the end of each line. (If the syntax theme allows it.) These are two spaces, which indicates that you want a hard line break at that point. The blank lines still indicate a paragraph. Press Ctrl+R to see what this renders like.
@@ -0,0 +1,6 @@
+%%~ bb2c23b3c42cc:f7e2d9f330615:f6622b4617424:Jane Smith
+# Jane Smith
+
+@tag: Jane
+
+She’s pretty cool. Not Angelina Jolie though.
@@ -0,0 +1,19 @@
+%%~ bc0cbd2a407f3:e7ded148d6e4a:7031beac91f75:Another Scene
+### Another Scene
+
+@pov: John
+@location: Earth
+
+Adding more scenes to a chapter is as easy as adding more scene files, with a level three heading, or just adding another level three heading in the same file if that works for the way you want to structure your files.
+
+In fact, if you wish, you can add all the scenes in the chapter file too. All novelWriter cares about is the level of the headings.
+
+### More Scenes
+
+@pov: Jane
+@location: Earth
+
+This is a second scene in the same file as the previous scene. You can always split the files up later.
+
+
+
@@ -0,0 +1,4 @@
+%%~ edca4be2fcaf8:7031beac91f75:Part One
+# Part One
+
+The first part.
@@ -0,0 +1,14 @@
+%%~ f1471bef9f2ae:15c4492bd5107:Space
+# Space
+
+@tag: Space
+
+Space … it’s an awful lot of nothing, with bits in it here and there. Some of which, people like to call home.
+
+## Outer Space
+
+@tag: OuterSpace
+
+Now even further into space!
+
+You can have more than one tag in a file, as long as there is only one tag per heading.