Update the sample project to reflect new functionality

This commit is contained in:
Veronica Berglyd Olsen
2022-05-17 17:51:40 +02:00
parent 304d122342
commit 9add2aaa87
8 changed files with 41 additions and 45 deletions
+4 -6
View File
@@ -7,13 +7,13 @@
@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.
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. The scene document can be sorted after the chapter document, or as a child of the chapter. Both result in the same output in the end, so it is a matter of preference.
Each paragraph in the scene is separated by a blank line. The text supports minimal formatting, like **bold**, _italic_ and **_bold italic_**. You can also ~~strike through~~ text. There is **some support for _nested_ emphasis**, but there are some known limitations. If the syntax highlighter doesnt show it correctly, the export tool will not either.
In addition, the editor supports automatic formatting of “quotes”, both double and single. Depending on the syntax highlighter, these can be in different colours. “You can of course use **bold** and _italic_ text inside of quotes too.”
In addition, the editor supports automatic formatting of “quotes”, both double and single. Depending on the syntax highlighter settings and colour theme, these can be in different colours. “You can of course use **bold** and _italic_ text inside of quotes too.”
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, lets 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.
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, lets 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 list of auto-replaced text is sett in Project Settings.
The editor also supports non breaking spaces, and the spell checker accepts long dashes—like this—as valid word separators. Regular dashes are also supported and can be automatically inserted when typing two hyphens.
@@ -25,7 +25,7 @@ If you need to split a scene file up into further pieces, you can do so with the
Both scene and section titles can be left out of the final exported document. The formatting of titles can be selected from the Build Novel Project dialog. You can also have them replaced with scene separators like “* * *”.
#### Text Alignment
#### Text Alignment and Indentation
The text by default will have the left or justified alignment in the main text files in your project. You can also specify alignment for a specific paragraph by “pushing” it away from an edge with a set of >> or << symbols, like so:
@@ -35,8 +35,6 @@ This text is left-aligned. <<
>> This text is centred. <<
#### Text Indent
You can indent a paragraph from both the left and right margin with > and < symbols.
> This paragraph is indented from both the left margin and the right margin. This is useful for when you want to quote a large chunk of text for instance. <
+3 -3
View File
@@ -1,11 +1,11 @@
%%~name: Chapter One
%%~path: e7ded148d6e4a/6a2d6d5f4f401
%%~path: 7031beac91f75/6a2d6d5f4f401
%%~kind: NOVEL/DOCUMENT
## 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.
% Synopsis: We can add a chapter document, but keep the scene files separate. In the chapter document we can set the meta data that applies to the whole chapter if we wish to. You can add the scenes as child documents directly under the chapter.
A chapter can also contain leading text before the first scene.
A chapter can contain leading text before the first scene, like this piece of text.
+2 -2
View File
@@ -1,6 +1,6 @@
%%~name: Old File
%%~path: ae9bf3c3ea159/8a5deb88c0e97
%%~kind: NOVEL/DOCUMENT
%%~kind: ARCHIVE/DOCUMENT
### Discarded Scene
If you have files you no longer want in your main project, you can move them to the “Archive” folder. This is equivalent to turning off the “Include when building project” switch, just that you also put the file away, although the switch can be ignored when building the project, this folder cannot.
If you have files you no longer want in your main project, you can move them to the “Archive” folder. This is equivalent to turning off the “Include when building project” switch, just that you also put the file away.
+5 -3
View File
@@ -1,11 +1,11 @@
%%~name: A Note on Structure
%%~path: e7ded148d6e4a/96b68994dfa3d
%%~path: 7031beac91f75/96b68994dfa3d
%%~kind: NOVEL/NOTE
# 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 isnt 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.
In root folders that arent the Novel or Archive root folders, you can _only_ add notes. In the Novel and Archive folder you can also add Project Documents, which are the documents that make up your actual story.
## Headers in Notes
@@ -15,8 +15,10 @@ Unlike in novel files, headers in notes have no particular meaning other than vi
The folders in the tree view have no structural meaning other than theyre 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.
If you do have separate chapter documents, you can always add scene documents as child document of the chapter instead of using folders.
## 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.
You can link project documents and notes together by assigning tags to the notes with the @tag keyword, and then reference them from other files using one of the many reference keywords. 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.
+1 -1
View File
@@ -6,4 +6,4 @@
This is a plain page with some text on it.
If you want the text to start on a fresh page, add the [NEW PAGE] code above the text. You can also add empty paragraphs with the [VSPACE] code.
If you want the text to start on a fresh page, add the [NEW PAGE] code above the text. You can also add empty paragraphs with the [VSPACE] code. The above code adds two empty paragraphs before the text starts.
+2 -2
View File
@@ -1,9 +1,9 @@
%%~name: Interlude
%%~path: e7ded148d6e4a/ba8a28a246524
%%~path: 7031beac91f75/ba8a28a246524
%%~kind: NOVEL/DOCUMENT
##! Interlude
% Notice that this is a file with the flag N.Un. The N means its a novel file, and the Un means its 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.
% Notice that this document has a title with a ! in it in addition to the two hash symbols. This means it is 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
+3 -3
View File
@@ -7,9 +7,9 @@
@focus: Jane
@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.
Adding more scenes to a chapter is as easy as adding more scene files with a level three heading. You can of course also just add 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.
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 and the order in which they appear.
### More Scenes
@@ -17,4 +17,4 @@ In fact, if you wish, you can add all the scenes in the chapter file too. All no
@focus: John
@location: Earth
This is a second scene in the same file as the previous scene. You can always split the files up later.
This is a second scene in the same file as the previous scene. You can always split the files up later using the split tool.