diff --git a/docs/source/_build/html/.doctrees/environment.pickle b/docs/source/_build/html/.doctrees/environment.pickle index 0d40bed2..ea7590ec 100644 Binary files a/docs/source/_build/html/.doctrees/environment.pickle and b/docs/source/_build/html/.doctrees/environment.pickle differ diff --git a/docs/source/_build/html/.doctrees/export.doctree b/docs/source/_build/html/.doctrees/export.doctree index 0fc94b14..997e49cb 100644 Binary files a/docs/source/_build/html/.doctrees/export.doctree and b/docs/source/_build/html/.doctrees/export.doctree differ diff --git a/docs/source/_build/html/.doctrees/introduction.doctree b/docs/source/_build/html/.doctrees/introduction.doctree index 84983aab..91fd3e38 100644 Binary files a/docs/source/_build/html/.doctrees/introduction.doctree and b/docs/source/_build/html/.doctrees/introduction.doctree differ diff --git a/docs/source/_build/html/_sources/export.rst.txt b/docs/source/_build/html/_sources/export.rst.txt index 62e81e2f..5cf24cff 100644 --- a/docs/source/_build/html/_sources/export.rst.txt +++ b/docs/source/_build/html/_sources/export.rst.txt @@ -9,20 +9,20 @@ Header Formatting ***************** The titles for the four levels of story structure can be formatted collectively in the export tool. -This is done through a series of keyword-replace steps. +This is done through a series of keyword–replace steps. The keyword ``%title%`` will always be replaced by the text you put after the ``#`` characters in your document. The keywords ``%ch%`` and ``%chw%`` is replaced by a number, or a number word, respectively. The number is incremented by one each time the build tool sees a new heading of level two in a file with layout "Chapter". -If the file has layout "Unnumbered", the counter is not incremented. -the latter is useful for for instance Prologue and Epilogue chapters. +If the file has layout "Unnumbered", the counter is *not* incremented. +The latter is useful for for instance Prologue and Epilogue chapters. Likewise, the keywords ``%sc%`` and ``%sca%`` are number counters for scene files. These are incremented each time a heading of level three is encountered. -The former keyword is reset to one for each new chapter, while the latter is not reset but counts from first scene encountered. +The former keyword is reset to one for each new chapter, while the latter is not reset but counts from first scene encountered in the project. -If you want to insert a line break in you=r title format, add two backslashes ``\\``. +If you want to insert a line break in your title format, add two backslashes ``\\``. .. note:: Header formatting only applies to novel files. @@ -42,22 +42,28 @@ File Selection Which files are selected for export can be controlled from the options on the left side of the dialog window. The switch for "Include novel files" will select any file that isn't classified as a note. +That is, files with layout "Book", "Page", "Partition", "Chapet", "Unnumbered", or "Scene". The switch for "Include note files" will select any file that is a note. +That is, files with layout "Note". This is allows for exporting just the novel, just your notes, or both, as you see fit. In addition, you can select to export the synopsis comments, regular comments, keywords, and even exclude the body text itself. -If you for instance want to export a document with an outline of the novel, you can enable keywords and synopsis export and disable body text, thus getting a document with each heading followed by the tags and references and the synopsis. +If you for instance want to export a document with an outline of the novel, you can enable keywords and synopsis export and disable body text, thus getting a document with each heading followed by the tags and references and the synopsis. + +If you need to exclude specific files from your exports, like draft files or files you want to take out of your build, but don't want to delete, you can uncheck the "Include when building project" option for each file in the project tree. +An included file has a checkmark after the status icon in the "Flags" column. +The "Build Novel Project" tool has a switch to ignore this flag if you need to collectively override these settings. ************** Export Formats ************** -Currently, five formats are supported for exporting. +Currently, six formats are supported for exporting. OpenDocument Format =================== -This is produces an open document odt file. +This is produces an open document ``.odt`` file. The document produced has very little formatting, and may require further editing afterwards. For a better formatted office document, you may get a better result with exporting to HTML and the import that HTML document in your office word processor. @@ -79,6 +85,12 @@ This is simply a concatenation of the files selected by the filters. The files in the project are stacked together in the order they appear in the tree view, with comments, tags, etc. included if they are selected. This is a useful format for exporting the project for later import back into novelWriter. +Standard Markdown +================= + +If you have Qt 5.14 or higher, the option to export to plain Markdown is available. +This feature uses Qt's own Markdown export feature. + Plain Text ========== diff --git a/docs/source/_build/html/_sources/introduction.rst.txt b/docs/source/_build/html/_sources/introduction.rst.txt index ad7117f1..13a83323 100644 --- a/docs/source/_build/html/_sources/introduction.rst.txt +++ b/docs/source/_build/html/_sources/introduction.rst.txt @@ -37,10 +37,9 @@ Project Export -------------- The project can at any time be exported to a range of different formats. -Natively, novelWriter supports export to plain text file, html5 document, LaTeX source file, novelWriter flavoured markdown, and standard markdown. -Additional export options are available through `Pandoc `_. -Currently, novelWriter will assist in converting the project to Open Office documents, Word documents, and epub. -However, to be able to fully take advantage of the many features of Pandoc, you may want to run it yourself and use the novelWriter html or markdown export as input. +Natively, novelWriter supports export to plain text file, HTML document, novelWriter flavoured markdown, standard markdown (requires Qt 5.14), and to a basic Open Document. +In addition, printing and printing to PDF is also possible. +The best supported export format is HTML, which can be imported or converted by a number of other tools like Pandoc, or simply imported into Libre Office and similar. Screenshot ---------- diff --git a/docs/source/_build/html/export.html b/docs/source/_build/html/export.html index 1c6e404c..a05c8abd 100644 --- a/docs/source/_build/html/export.html +++ b/docs/source/_build/html/export.html @@ -46,16 +46,16 @@

Header Formatting

The titles for the four levels of story structure can be formatted collectively in the export tool. -This is done through a series of keyword-replace steps.

+This is done through a series of keyword–replace steps.

The keyword %title% will always be replaced by the text you put after the # characters in your document.

The keywords %ch% and %chw% is replaced by a number, or a number word, respectively. The number is incremented by one each time the build tool sees a new heading of level two in a file with layout “Chapter”. -If the file has layout “Unnumbered”, the counter is not incremented. -the latter is useful for for instance Prologue and Epilogue chapters.

+If the file has layout “Unnumbered”, the counter is not incremented. +The latter is useful for for instance Prologue and Epilogue chapters.

Likewise, the keywords %sc% and %sca% are number counters for scene files. These are incremented each time a heading of level three is encountered. -The former keyword is reset to one for each new chapter, while the latter is not reset but counts from first scene encountered.

-

If you want to insert a line break in you=r title format, add two backslashes \\.

+The former keyword is reset to one for each new chapter, while the latter is not reset but counts from first scene encountered in the project.

+

If you want to insert a line break in your title format, add two backslashes \\.

Note

Header formatting only applies to novel files. @@ -72,17 +72,22 @@ In fact, if the format is a piece of static text, it will always be treated as a

File Selection

Which files are selected for export can be controlled from the options on the left side of the dialog window. The switch for “Include novel files” will select any file that isn’t classified as a note. +That is, files with layout “Book”, “Page”, “Partition”, “Chapet”, “Unnumbered”, or “Scene”. The switch for “Include note files” will select any file that is a note. +That is, files with layout “Note”. This is allows for exporting just the novel, just your notes, or both, as you see fit.

In addition, you can select to export the synopsis comments, regular comments, keywords, and even exclude the body text itself. -If you for instance want to export a document with an outline of the novel, you can enable keywords and synopsis export and disable body text, thus getting a document with each heading followed by the tags and references and the synopsis.

+If you for instance want to export a document with an outline of the novel, you can enable keywords and synopsis export and disable body text, thus getting a document with each heading followed by the tags and references and the synopsis.

+

If you need to exclude specific files from your exports, like draft files or files you want to take out of your build, but don’t want to delete, you can uncheck the “Include when building project” option for each file in the project tree. +An included file has a checkmark after the status icon in the “Flags” column. +The “Build Novel Project” tool has a switch to ignore this flag if you need to collectively override these settings.

Export Formats

-

Currently, five formats are supported for exporting.

+

Currently, six formats are supported for exporting.

OpenDocument Format

-

This is produces an open document odt file. +

This is produces an open document .odt file. The document produced has very little formatting, and may require further editing afterwards. For a better formatted office document, you may get a better result with exporting to HTML and the import that HTML document in your office word processor.

@@ -101,6 +106,11 @@ The exported HTML file is suitable for further processing by document conversion The files in the project are stacked together in the order they appear in the tree view, with comments, tags, etc. included if they are selected. This is a useful format for exporting the project for later import back into novelWriter.

+
+

Standard Markdown

+

If you have Qt 5.14 or higher, the option to export to plain Markdown is available. +This feature uses Qt’s own Markdown export feature.

+

Plain Text

The plain text export format writes a simple .txt file without any formatting at all.

@@ -125,6 +135,7 @@ This is a useful format for exporting the project for later import back into nov
  • PDF Format
  • novelWriter HTML
  • novelWriter Markdown
    • +
  • Standard Markdown
  • Plain Text
    • diff --git a/docs/source/_build/html/introduction.html b/docs/source/_build/html/introduction.html index b52595f8..33ee2814 100644 --- a/docs/source/_build/html/introduction.html +++ b/docs/source/_build/html/introduction.html @@ -71,10 +71,9 @@ H4 is for section titles within scenes, if such granularity is necessary.

    Project Export

    The project can at any time be exported to a range of different formats. -Natively, novelWriter supports export to plain text file, html5 document, LaTeX source file, novelWriter flavoured markdown, and standard markdown. -Additional export options are available through Pandoc. -Currently, novelWriter will assist in converting the project to Open Office documents, Word documents, and epub. -However, to be able to fully take advantage of the many features of Pandoc, you may want to run it yourself and use the novelWriter html or markdown export as input.

    +Natively, novelWriter supports export to plain text file, HTML document, novelWriter flavoured markdown, standard markdown (requires Qt 5.14), and to a basic Open Document. +In addition, printing and printing to PDF is also possible. +The best supported export format is HTML, which can be imported or converted by a number of other tools like Pandoc, or simply imported into Libre Office and similar.

    Screenshot

    diff --git a/docs/source/_build/html/searchindex.js b/docs/source/_build/html/searchindex.js index 18096524..d0f1fd65 100644 --- a/docs/source/_build/html/searchindex.js +++ b/docs/source/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["export","index","interface","introduction","notes","projects","started","structure","technical"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":2,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["export.rst","index.rst","interface.rst","introduction.rst","notes.rst","projects.rst","started.rst","structure.rst","technical.rst"],objects:{},objnames:{},objtypes:{},terms:{"break":[0,2,7],"case":[2,7],"char":7,"class":5,"default":[3,5],"export":[1,2,5,6,7],"final":5,"import":[0,1,2,8],"long":4,"new":[0,2,3,5,7,8],"return":2,"static":0,"switch":[0,2,6],"try":[5,6],"while":[0,2,3,5,7],For:[0,3,5,7],That:[2,8],The:[0,2,3,4,5,6,7],There:[6,7],These:[0,2,3,4,5,7],Use:7,__text__:2,_text_:2,abl:[3,5],about:[2,5],abov:5,access:[3,5],achiev:2,activ:2,adapt:8,add:[0,2,3,4,5,6,8],added:[5,8],adding:5,addit:[0,2,3],advantag:3,after:[0,2],afterward:0,again:[2,5],alert:[4,7],all:[0,2,5,6,7,8],allow:[0,2,4,7],alreadi:6,also:[0,2,4,5,6,7,8],alt:2,alter:2,altern:[0,2],although:[5,8],alwai:[0,2,8],angl:5,ani:[0,2,3,4,5,8],anyth:[2,5],appear:[0,5],appli:[0,3,5,7],applic:[4,5],archiv:6,argument:2,asid:5,assist:[3,6],associ:[4,5],author:5,auto:8,autom:5,automat:[2,5,6,7,8],avail:[0,2,3,5,6],avoid:[2,8],back:[0,2,5,8],background:2,backslash:0,backup:[1,8],bak:8,bar:2,base:2,basic:2,becom:[2,4,8],been:[5,8],being:2,below:[2,5,7],benefit:5,best:2,better:0,between:[0,2,4,5],block:2,bodi:0,bold:[2,3],book:[3,5,7],both:[0,2],bottom:2,box:[0,5],bracket:5,browser:0,build:[0,1,2],built:[5,6,8],call:3,can:[0,2,3,4,5,6,7,8],cannot:[2,5],categori:5,caus:5,chang:[2,5,8],chapter:[0,3,7],charact:[0,4,5,7,8],chatract:8,check:[2,6],checker:2,choic:6,chw:0,classifi:0,click:2,clickabl:[2,4,7],clipboard:2,close:[2,5],cmd:2,code:6,collect:0,colour:[2,3,5],column:[2,5],com:6,comma:2,command:6,comment:[0,2],common:0,compani:5,complet:3,concaten:0,concern:7,configur:5,conflict:5,connect:[4,7],consequ:8,contain:[2,5,7,8],content:[1,2,5,7,8],continu:5,control:[0,7,8],conveni:5,convent:8,convers:0,convert:[0,3,8],copi:2,core:5,correct:[0,2,5,7],correctli:[2,4],correspond:[5,7],corrupt:8,count:[0,2],counter:[0,2],cours:5,cover:[5,7],crash:5,creat:[2,5,8],cross:4,cryptic:8,ctrl:[2,5],current:[0,2,3,5,6,7],cursor:2,custom:[5,7],cut:2,dark:3,data:[1,2,3,5],data_:8,date:[2,4,5,7],debug:6,dedic:[5,8],defin:[5,7],del:2,delet:[2,5,8],depend:[1,2,8],deriv:8,describ:2,descript:2,design:1,desir:8,desktop:6,detail:[2,5,8],detect:4,dialog:[0,2,5],dictat:7,dif:8,diff:8,differ:[2,3,5,7,8],disabl:[0,2],disk:5,displai:[2,5],dissabl:5,dist:6,distract:2,diverg:5,document:[0,2,3,4],doe:[2,6,8],doesn:3,don:[0,6],done:[0,2],doubl:2,down:2,download:6,drag:2,dummi:5,duplic:4,dure:5,each:[0,2,4,5,7,8],easi:7,easier:[4,7],easiest:6,easili:8,edit:[0,2,5,8],editor:[2,3,4,5,8],effect:5,either:[2,5,6,7,8],element:[2,4,5],els:5,empti:[0,5],enabl:[0,2,7,8],encod:8,encount:[0,6],end:[2,8],ensur:[5,8],enter:[0,2],entir:[2,3,5,7],entiti:[5,7],entri:[5,8],epilogu:0,epub:3,error:6,especi:5,etc:[0,7],even:0,event:5,except:8,exclud:[0,8],execut:1,exist:7,exit:[2,5],extens:8,extern:8,extract:[2,6],f10:2,f11:2,fact:[0,5],fairli:3,featur:[1,3,4,5,6,7],few:6,file:[1,2,3,6],filenam:[5,8],filter:0,find:[2,6,8],fine:6,first:[0,2,8],fit:0,five:0,flag:[2,7],flavour:3,focu:2,folder:[2,3,4,6,7,8],follow:[0,2,4,5,6],format:[1,3,4,7,8],former:0,forward:3,four:[0,2,3,7],free:3,from:[0,2,5,6,7,8],full:[2,3,5],fulli:3,further:[0,5,7],gather:7,gener:[3,5,7],get:[0,1],git:8,github:6,gitignor:8,give:5,given:5,goe:5,granular:[3,7],graphic:6,gui:[5,6],had:5,hand:[2,3],handl:8,hard:2,has:[0,2,3,5,8],hash:[7,8],have:[0,4,5,6,7,8],head:[0,1,2,3],header1:7,header2:7,header3:7,header4:7,header:[1,2,3,7],help:[6,8],here:5,hidden:2,hide:2,hierarchi:2,higher:6,highlight:[2,4,7],hit:2,hold:5,how:[1,3,4,5,7],howev:[3,5],htm:0,html5:3,html:3,http:6,icon:[5,6],ideal:6,identifi:4,ignor:[2,5,7],imag:3,impact:7,impli:[3,5],includ:[0,7,8],inconsist:5,increment:0,index:[1,2,4,7],indic:[1,2,7],inform:[1,2,5],input:3,insert:[0,2],instal:1,instanc:[0,5],instead:[0,6,7],intend:[3,4,5],intent:5,inter:3,interconnect:3,interfac:[1,3],intern:7,interpret:7,intersect:4,introduct:1,isn:[0,5],issu:8,ital:2,italic:2,italicis:3,item:[2,5],its:[2,3,5,8],itself:[0,2,3,4,7,8],json:8,jump:5,just:[0,5,7,8],keep:[2,8],kei:2,kept:2,keyboard:[1,3],keyword:[0,2,3,4,5,7],kind:7,known:6,label:[5,8],laid:3,larg:2,last:[2,8],later:[0,5],latest:[2,6],latex:3,latter:0,layout:[0,1,5],least:[4,5,6],leav:[0,2],left:[0,3,5],level:[0,2,3,5,7],librari:6,like:[0,2,5,8],likewis:0,limit:3,line:[0,2,5,6,7,8],link:[2,3,4],linux:6,list:[2,5,6,7],littl:0,live:3,local:5,locat:[4,5,6,7,8],lock:5,look:8,lost:8,lxml:6,mac:2,maco:2,mai:[0,2,3,5,8],main:[2,3,5],mainli:8,maintain:5,make:[3,4,5,6,7,8],manag:3,mandatori:2,mangl:8,mani:3,manual:[2,5],mark:2,markdown:[1,3,6,7],mean:3,meaning:5,menu:[2,3,5,7,8],met:6,meta:[2,3,5,8],minim:[0,2,4],minimalist:3,minimum:6,miss:2,mode:2,modifi:3,modul:1,more:[2,5],most:[2,3],mostli:6,move:[2,5],multi:3,multipl:[2,5,7],must:[5,6,7],name:[5,7,8],nativ:3,navig:7,nearli:6,necessari:[3,7],need:[2,3,5,6,7],next:[2,5],non:[2,5],normal:7,note:[0,1,3,5,6,7],novel:[0,1,2,3,4],novelwrit:[2,3,5,8],number:[0,7],nwproject:8,nwx:8,object:[5,7],occurr:2,odt:0,off:2,offic:[0,3],old:8,onc:6,one:[0,2,5,6,7],ones:5,onli:[0,2,4,5,7,8],open:[0,2,3,4,5,6,8],oper:[6,8],option:[0,2,3,5,6,7],order:[0,2,5],org:6,organis:5,origin:6,other:[4,5,7],otherwis:[5,8],out:[3,7],outlin:[0,1,4,5,7],output:0,overal:7,overview:[2,3,7],own:[3,8],packag:6,page:[1,7],pandoc:[0,3],pane:[2,4,5],panel:[2,5,7],paragraph:[0,2],parallel:2,part:[4,5,7],partit:[3,7],past:2,path:[5,6],per:[5,7],perman:5,philosophi:1,physic:8,piec:0,pip:6,place:7,plain:[3,7,8],pleas:6,plot:[4,5,7],point:[5,7],posit:2,possibl:[2,3,4,5],potenti:5,pov:7,practic:3,preced:7,prefer:5,present:[5,7],preserv:2,press:[0,2,5,7],prevent:5,previou:[2,8],previous:8,principl:[5,7,8],print:0,process:[0,5],processor:[0,3],produc:0,project:[1,6],prologu:0,prompt:6,provid:[2,3,5,6],pure:5,put:0,pyenchant:6,pyinstal:6,pyqt5:6,pyqt:6,python3:6,python:[6,8],quot:2,rang:3,rearrang:2,reason:[5,8],rebuild:[2,7],rebuilt:2,receiv:7,recent:5,recommend:6,redo:2,refer:[0,1,2,4],referenc:[2,4,7],regener:[2,7],region:7,regular:0,releas:6,reli:[2,5],remain:[5,8],remov:2,renam:8,render:2,replac:[0,2,8],requir:[0,2,4,5,6,8],reserv:3,reset:0,respect:0,rest:[4,8],restor:[5,8],restrict:[5,7,8],result:0,right:[2,5],root:[3,4,5,7],rule:5,run:[1,2,3,5],safe:5,same:[2,3,4,5,7,8],save:[2,5,7],sca:0,scene:[1,3,5,7],scheme:3,screen:2,screenshot:1,script:6,search:[1,2],second:2,section:[0,2,3,4,5,7,8],see:[0,4,5,7],seem:2,seen:2,select:[1,2,5,6,7,8],sensit:2,separ:[1,2,6],seri:0,set:[1,2,3,6,7,8],sha256:8,shift:2,shortcut:[0,1,3],should:[4,5,6,7],shouldn:7,show:[2,4,7,8],side:[0,2,3,5],signifi:[5,7],signific:5,simpl:[0,2,3],simpli:[0,2,5],simplifi:2,sinc:8,singl:[0,2,7],small:2,solut:8,some:[5,6,7,8],sometim:6,sourc:[3,6],space:[2,5],special:[2,3,5],specif:[2,5,7,8],spell:[2,6],split:7,stack:0,stage:5,stamp:5,standalon:1,standard:[2,3],start:[1,5,7,8],state:5,step:[0,2],store:[1,4,5],stori:[0,5],straight:3,structur:[0,1,2,3,8],style:0,sub:7,subfold:[5,7],success:[6,8],successfulli:8,suitabl:[0,8],summari:4,support:[0,1,2,3,5,6,7],sure:[6,8],svg:6,sync:5,synchronis:5,synopsi:[0,1],syntax:[3,4,7],system:[3,5,6,8],tab:2,tabl:[1,3],tag:[0,1,2,5],tagnam:4,take:[2,3,5,7],taken:8,tar:6,target:7,technic:[1,5],teh:2,temporari:8,term:7,text:[2,3,5,7,8],than:5,thei:[0,3,4,5,7,8],them:[0,2,4,5],theme:[2,3],thi:[0,1,2,5,6,7,8],three:[0,2,7],through:[0,3,8],thu:0,tile:3,time:[0,3,5,7,8],timelin:[2,5,7],timesetamp:8,titl:[0,2,3,5,7],togeth:0,toggl:2,told:5,tool:[0,2,5,6,7,8],top:7,touch:7,toward:2,track:[5,7],trash:[2,5],treat:[0,7],tree:[0,2,3,7,8],trigger:2,turn:2,two:[0,2,7],txt:[0,6],type:[3,5,6,7],ues:5,unchang:5,under:[2,3,7],underlin:[2,3],undo:2,unicod:8,unintention:5,uniqu:4,unix:8,unnumb:[0,7],updat:2,usag:3,use:[3,4,5,6,7],used:[2,3,4,5,7],useful:[0,5],user:[1,3,4,5,7,8],uses:[2,4],using:[0,3,6],utf:8,valid:7,valu:[2,5,7],value1:7,value2:7,valuen:7,variou:[0,2,3,4,5],veri:[0,2],version:[6,8],view:[0,1,3,4,5,7,8],viewer:[2,4,5],visibl:5,vkbo:6,wai:[4,5,6],want:[0,2,3,5,6,8],warn:5,websit:6,well:2,what:[5,7,8],whatev:[3,4,5],when:[2,4,5,7,8],whenev:2,where:[4,5,6,7],which:[0,2,5],wile:5,window:[0,2,3,5,8],wish:[4,8],within:[3,5],without:[0,5,8],word:[0,2,3],work:[5,6],world:5,wrap:2,write:[0,1,2,3,6,7],writer:4,written:[5,6,8],wrong:2,www:6,x86:6,xml:8,you:[0,2,3,5,6,7,8],your:[0,2,5,6,8],yourself:3,zen:2,zip:[5,6]},titles:["Exporting Projects","Welcome to novelWriter Documentation","User Interface","Introduction","Supporting Files (Notes)","Novel Projects","Getting Started","Project Structure","Technical Information"],titleterms:{"export":[0,3],"import":[5,7],The:8,Using:5,addit:6,auto:5,backup:5,build:6,data:8,depend:6,design:3,document:[1,5,8],execut:6,featur:2,file:[0,4,5,7,8],folder:5,format:[0,2],get:6,head:7,header:0,how:8,html:0,inform:8,instal:6,instruct:6,interfac:2,introduct:3,keyboard:2,layout:[3,7],lockfil:5,main:8,markdown:[0,2],note:4,novel:[5,7],novelwrit:[0,1,6],opendocu:0,orphan:5,outlin:2,pdf:0,philosophi:3,plain:0,process:8,project:[0,2,3,5,7,8],refer:7,replac:5,run:6,save:8,scene:0,screenshot:3,select:0,separ:0,set:5,shortcut:2,standalon:6,start:6,statu:5,store:8,structur:[5,7],support:4,synopsi:2,syntax:2,tab:5,tag:[4,7],technic:8,text:0,tree:5,user:2,view:2,welcom:1,window:6,write:5}}) \ No newline at end of file +Search.setIndex({docnames:["export","index","interface","introduction","notes","projects","started","structure","technical"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":2,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["export.rst","index.rst","interface.rst","introduction.rst","notes.rst","projects.rst","started.rst","structure.rst","technical.rst"],objects:{},objnames:{},objtypes:{},terms:{"break":[0,2,7],"case":[2,7],"char":7,"class":5,"default":[3,5],"export":[1,2,5,6,7],"final":5,"import":[0,1,2,3,8],"long":4,"new":[0,2,3,5,7,8],"return":2,"static":0,"switch":[0,2,6],"try":[5,6],"while":[0,2,3,5,7],For:[0,3,5,7],That:[0,2,8],The:[0,2,3,4,5,6,7],There:[6,7],These:[0,2,3,4,5,7],Use:7,__text__:2,_text_:2,abl:5,about:[2,5],abov:5,access:[3,5],achiev:2,activ:2,adapt:8,add:[0,2,3,4,5,6,8],added:[5,8],adding:5,addit:[0,2,3],advantag:[],after:[0,2],afterward:0,again:[2,5],alert:[4,7],all:[0,2,5,6,7,8],allow:[0,2,4,7],alreadi:6,also:[0,2,3,4,5,6,7,8],alt:2,alter:2,altern:[0,2],although:[5,8],alwai:[0,2,8],angl:5,ani:[0,2,3,4,5,8],anyth:[2,5],appear:[0,5],appli:[0,3,5,7],applic:[4,5],archiv:6,argument:2,asid:5,assist:6,associ:[4,5],author:5,auto:8,autom:5,automat:[2,5,6,7,8],avail:[0,2,3,5,6],avoid:[2,8],back:[0,2,5,8],background:2,backslash:0,backup:[1,8],bak:8,bar:2,base:2,basic:[2,3],becom:[2,4,8],been:[5,8],being:2,below:[2,5,7],benefit:5,best:[2,3],better:0,between:[0,2,4,5],block:2,bodi:0,bold:[2,3],book:[0,3,5,7],both:[0,2],bottom:2,box:[0,5],bracket:5,browser:0,build:[0,1,2],built:[5,6,8],call:3,can:[0,2,3,4,5,6,7,8],cannot:[2,5],categori:5,caus:5,chang:[2,5,8],chapet:0,chapter:[0,3,7],charact:[0,4,5,7,8],chatract:8,check:[2,6],checker:2,checkmark:0,choic:6,chw:0,classifi:0,click:2,clickabl:[2,4,7],clipboard:2,close:[2,5],cmd:2,code:6,collect:0,colour:[2,3,5],column:[0,2,5],com:6,comma:2,command:6,comment:[0,2],common:0,compani:5,complet:3,concaten:0,concern:7,configur:5,conflict:5,connect:[4,7],consequ:8,contain:[2,5,7,8],content:[1,2,5,7,8],continu:5,control:[0,7,8],conveni:5,convent:8,convers:0,convert:[0,3,8],copi:2,core:5,correct:[0,2,5,7],correctli:[2,4],correspond:[5,7],corrupt:8,count:[0,2],counter:[0,2],cours:5,cover:[5,7],crash:5,creat:[2,5,8],cross:4,cryptic:8,ctrl:[2,5],current:[0,2,5,6,7],cursor:2,custom:[5,7],cut:2,dark:3,data:[1,2,3,5],data_:8,date:[2,4,5,7],debug:6,dedic:[5,8],defin:[5,7],del:2,delet:[0,2,5,8],depend:[1,2,8],deriv:8,describ:2,descript:2,design:1,desir:8,desktop:6,detail:[2,5,8],detect:4,dialog:[0,2,5],dictat:7,dif:8,diff:8,differ:[2,3,5,7,8],disabl:[0,2],disk:5,displai:[2,5],dissabl:5,dist:6,distract:2,diverg:5,document:[0,2,3,4],doe:[2,6,8],doesn:3,don:[0,6],done:[0,2],doubl:2,down:2,download:6,draft:0,drag:2,dummi:5,duplic:4,dure:5,each:[0,2,4,5,7,8],easi:7,easier:[4,7],easiest:6,easili:8,edit:[0,2,5,8],editor:[2,3,4,5,8],effect:5,either:[2,5,6,7,8],element:[2,4,5],els:5,empti:[0,5],enabl:[0,2,7,8],encod:8,encount:[0,6],end:[2,8],ensur:[5,8],enter:[0,2],entir:[2,3,5,7],entiti:[5,7],entri:[5,8],epilogu:0,epub:[],error:6,especi:5,etc:[0,7],even:0,event:5,except:8,exclud:[0,8],execut:1,exist:7,exit:[2,5],extens:8,extern:8,extract:[2,6],f10:2,f11:2,fact:[0,5],fairli:3,featur:[0,1,3,4,5,6,7],few:6,file:[1,2,3,6],filenam:[5,8],filter:0,find:[2,6,8],fine:6,first:[0,2,8],fit:0,five:[],flag:[0,2,7],flavour:3,focu:2,folder:[2,3,4,6,7,8],follow:[0,2,4,5,6],format:[1,3,4,7,8],former:0,forward:3,four:[0,2,3,7],free:3,from:[0,2,5,6,7,8],full:[2,3,5],fulli:[],further:[0,5,7],gather:7,gener:[3,5,7],get:[0,1],git:8,github:6,gitignor:8,give:5,given:5,goe:5,granular:[3,7],graphic:6,gui:[5,6],had:5,hand:[2,3],handl:8,hard:2,has:[0,2,3,5,8],hash:[7,8],have:[0,4,5,6,7,8],head:[0,1,2,3],header1:7,header2:7,header3:7,header4:7,header:[1,2,3,7],help:[6,8],here:5,hidden:2,hide:2,hierarchi:2,higher:[0,6],highlight:[2,4,7],hit:2,hold:5,how:[1,3,4,5,7],howev:5,htm:0,html5:[],html:3,http:6,icon:[0,5,6],ideal:6,identifi:4,ignor:[0,2,5,7],imag:3,impact:7,impli:[3,5],includ:[0,7,8],inconsist:5,increment:0,index:[1,2,4,7],indic:[1,2,7],inform:[1,2,5],input:[],insert:[0,2],instal:1,instanc:[0,5],instead:[0,6,7],intend:[3,4,5],intent:5,inter:3,interconnect:3,interfac:[1,3],intern:7,interpret:7,intersect:4,introduct:1,isn:[0,5],issu:8,ital:2,italic:2,italicis:3,item:[2,5],its:[2,3,5,8],itself:[0,2,3,4,7,8],json:8,jump:5,just:[0,5,7,8],keep:[2,8],kei:2,kept:2,keyboard:[1,3],keyword:[0,2,3,4,5,7],kind:7,known:6,label:[5,8],laid:3,larg:2,last:[2,8],later:[0,5],latest:[2,6],latex:[],latter:0,layout:[0,1,5],least:[4,5,6],leav:[0,2],left:[0,3,5],level:[0,2,3,5,7],libr:3,librari:6,like:[0,2,3,5,8],likewis:0,limit:3,line:[0,2,5,6,7,8],link:[2,3,4],linux:6,list:[2,5,6,7],littl:0,live:3,local:5,locat:[4,5,6,7,8],lock:5,look:8,lost:8,lxml:6,mac:2,maco:2,mai:[0,2,3,5,8],main:[2,3,5],mainli:8,maintain:5,make:[3,4,5,6,7,8],manag:3,mandatori:2,mangl:8,mani:[],manual:[2,5],mark:2,markdown:[1,3,6,7],mean:3,meaning:5,menu:[2,3,5,7,8],met:6,meta:[2,3,5,8],minim:[0,2,4],minimalist:3,minimum:6,miss:2,mode:2,modifi:3,modul:1,more:[2,5],most:[2,3],mostli:6,move:[2,5],multi:3,multipl:[2,5,7],must:[5,6,7],name:[5,7,8],nativ:3,navig:7,nearli:6,necessari:[3,7],need:[0,2,3,5,6,7],next:[2,5],non:[2,5],normal:7,note:[0,1,3,5,6,7],novel:[0,1,2,3,4],novelwrit:[2,3,5,8],number:[0,3,7],nwproject:8,nwx:8,object:[5,7],occurr:2,odt:0,off:2,offic:[0,3],old:8,onc:6,one:[0,2,5,6,7],ones:5,onli:[0,2,4,5,7,8],open:[0,2,3,4,5,6,8],oper:[6,8],option:[0,2,5,6,7],order:[0,2,5],org:6,organis:5,origin:6,other:[3,4,5,7],otherwis:[5,8],out:[0,3,7],outlin:[0,1,4,5,7],output:0,overal:7,overrid:0,overview:[2,3,7],own:[0,3,8],packag:6,page:[0,1,7],pandoc:[0,3],pane:[2,4,5],panel:[2,5,7],paragraph:[0,2],parallel:2,part:[4,5,7],partit:[0,3,7],past:2,path:[5,6],pdf:3,per:[5,7],perman:5,philosophi:1,physic:8,piec:0,pip:6,place:7,plain:[3,7,8],pleas:6,plot:[4,5,7],point:[5,7],posit:2,possibl:[2,3,4,5],potenti:5,pov:7,practic:3,preced:7,prefer:5,present:[5,7],preserv:2,press:[0,2,5,7],prevent:5,previou:[2,8],previous:8,principl:[5,7,8],print:[0,3],process:[0,5],processor:[0,3],produc:0,project:[1,6],prologu:0,prompt:6,provid:[2,3,5,6],pure:5,put:0,pyenchant:6,pyinstal:6,pyqt5:6,pyqt:6,python3:6,python:[6,8],quot:2,rang:3,rearrang:2,reason:[5,8],rebuild:[2,7],rebuilt:2,receiv:7,recent:5,recommend:6,redo:2,refer:[0,1,2,4],referenc:[2,4,7],regener:[2,7],region:7,regular:0,releas:6,reli:[2,5],remain:[5,8],remov:2,renam:8,render:2,replac:[0,2,8],requir:[0,2,3,4,5,6,8],reserv:3,reset:0,respect:0,rest:[4,8],restor:[5,8],restrict:[5,7,8],result:0,right:[2,5],root:[3,4,5,7],rule:5,run:[1,2,5],safe:5,same:[2,3,4,5,7,8],save:[2,5,7],sca:0,scene:[1,3,5,7],scheme:3,screen:2,screenshot:1,script:6,search:[1,2],second:2,section:[0,2,3,4,5,7,8],see:[0,4,5,7],seem:2,seen:2,select:[1,2,5,6,7,8],sensit:2,separ:[1,2,6],seri:0,set:[0,1,2,3,6,7,8],sha256:8,shift:2,shortcut:[0,1,3],should:[4,5,6,7],shouldn:7,show:[2,4,7,8],side:[0,2,3,5],signifi:[5,7],signific:5,similar:3,simpl:[0,2,3],simpli:[0,2,3,5],simplifi:2,sinc:8,singl:[0,2,7],six:0,small:2,solut:8,some:[5,6,7,8],sometim:6,sourc:6,space:[2,5],special:[2,3,5],specif:[0,2,5,7,8],spell:[2,6],split:7,stack:0,stage:5,stamp:5,standalon:1,standard:[2,3],start:[1,5,7,8],state:5,statu:0,step:[0,2],store:[1,4,5],stori:[0,5],straight:3,structur:[0,1,2,3,8],style:0,sub:7,subfold:[5,7],success:[6,8],successfulli:8,suitabl:[0,8],summari:4,support:[0,1,2,3,5,6,7],sure:[6,8],svg:6,sync:5,synchronis:5,synopsi:[0,1],syntax:[3,4,7],system:[3,5,6,8],tab:2,tabl:[1,3],tag:[0,1,2,5],tagnam:4,take:[0,2,5,7],taken:8,tar:6,target:7,technic:[1,5],teh:2,temporari:8,term:7,text:[2,3,5,7,8],than:5,thei:[0,3,4,5,7,8],them:[0,2,4,5],theme:[2,3],thi:[0,1,2,5,6,7,8],three:[0,2,7],through:[0,3,8],thu:0,tile:3,time:[0,3,5,7,8],timelin:[2,5,7],timesetamp:8,titl:[0,2,3,5,7],togeth:0,toggl:2,told:5,tool:[0,2,3,5,6,7,8],top:7,touch:7,toward:2,track:[5,7],trash:[2,5],treat:[0,7],tree:[0,2,3,7,8],trigger:2,turn:2,two:[0,2,7],txt:[0,6],type:[3,5,6,7],ues:5,unchang:5,uncheck:0,under:[2,3,7],underlin:[2,3],undo:2,unicod:8,unintention:5,uniqu:4,unix:8,unnumb:[0,7],updat:2,usag:3,use:[4,5,6,7],used:[2,3,4,5,7],useful:[0,5],user:[1,3,4,5,7,8],uses:[0,2,4],using:[0,3,6],utf:8,valid:7,valu:[2,5,7],value1:7,value2:7,valuen:7,variou:[0,2,3,4,5],veri:[0,2],version:[6,8],view:[0,1,3,4,5,7,8],viewer:[2,4,5],visibl:5,vkbo:6,wai:[4,5,6],want:[0,2,3,5,6,8],warn:5,websit:6,well:2,what:[5,7,8],whatev:[3,4,5],when:[0,2,4,5,7,8],whenev:2,where:[4,5,6,7],which:[0,2,3,5],wile:5,window:[0,2,3,5,8],wish:[4,8],within:[3,5],without:[0,5,8],word:[0,2,3],work:[5,6],world:5,wrap:2,write:[0,1,2,3,6,7],writer:4,written:[5,6,8],wrong:2,www:6,x86:6,xml:8,you:[0,2,5,6,7,8],your:[0,2,5,6,8],yourself:[],zen:2,zip:[5,6]},titles:["Exporting Projects","Welcome to novelWriter Documentation","User Interface","Introduction","Supporting Files (Notes)","Novel Projects","Getting Started","Project Structure","Technical Information"],titleterms:{"export":[0,3],"import":[5,7],The:8,Using:5,addit:6,auto:5,backup:5,build:6,data:8,depend:6,design:3,document:[1,5,8],execut:6,featur:2,file:[0,4,5,7,8],folder:5,format:[0,2],get:6,head:7,header:0,how:8,html:0,inform:8,instal:6,instruct:6,interfac:2,introduct:3,keyboard:2,layout:[3,7],lockfil:5,main:8,markdown:[0,2],note:4,novel:[5,7],novelwrit:[0,1,6],opendocu:0,orphan:5,outlin:2,pdf:0,philosophi:3,plain:0,process:8,project:[0,2,3,5,7,8],refer:7,replac:5,run:6,save:8,scene:0,screenshot:3,select:0,separ:0,set:5,shortcut:2,standalon:6,standard:0,start:6,statu:5,store:8,structur:[5,7],support:4,synopsi:2,syntax:2,tab:5,tag:[4,7],technic:8,text:0,tree:5,user:2,view:2,welcom:1,window:6,write:5}}) \ No newline at end of file diff --git a/docs/source/export.rst b/docs/source/export.rst index 62e81e2f..5cf24cff 100644 --- a/docs/source/export.rst +++ b/docs/source/export.rst @@ -9,20 +9,20 @@ Header Formatting ***************** The titles for the four levels of story structure can be formatted collectively in the export tool. -This is done through a series of keyword-replace steps. +This is done through a series of keyword–replace steps. The keyword ``%title%`` will always be replaced by the text you put after the ``#`` characters in your document. The keywords ``%ch%`` and ``%chw%`` is replaced by a number, or a number word, respectively. The number is incremented by one each time the build tool sees a new heading of level two in a file with layout "Chapter". -If the file has layout "Unnumbered", the counter is not incremented. -the latter is useful for for instance Prologue and Epilogue chapters. +If the file has layout "Unnumbered", the counter is *not* incremented. +The latter is useful for for instance Prologue and Epilogue chapters. Likewise, the keywords ``%sc%`` and ``%sca%`` are number counters for scene files. These are incremented each time a heading of level three is encountered. -The former keyword is reset to one for each new chapter, while the latter is not reset but counts from first scene encountered. +The former keyword is reset to one for each new chapter, while the latter is not reset but counts from first scene encountered in the project. -If you want to insert a line break in you=r title format, add two backslashes ``\\``. +If you want to insert a line break in your title format, add two backslashes ``\\``. .. note:: Header formatting only applies to novel files. @@ -42,22 +42,28 @@ File Selection Which files are selected for export can be controlled from the options on the left side of the dialog window. The switch for "Include novel files" will select any file that isn't classified as a note. +That is, files with layout "Book", "Page", "Partition", "Chapet", "Unnumbered", or "Scene". The switch for "Include note files" will select any file that is a note. +That is, files with layout "Note". This is allows for exporting just the novel, just your notes, or both, as you see fit. In addition, you can select to export the synopsis comments, regular comments, keywords, and even exclude the body text itself. -If you for instance want to export a document with an outline of the novel, you can enable keywords and synopsis export and disable body text, thus getting a document with each heading followed by the tags and references and the synopsis. +If you for instance want to export a document with an outline of the novel, you can enable keywords and synopsis export and disable body text, thus getting a document with each heading followed by the tags and references and the synopsis. + +If you need to exclude specific files from your exports, like draft files or files you want to take out of your build, but don't want to delete, you can uncheck the "Include when building project" option for each file in the project tree. +An included file has a checkmark after the status icon in the "Flags" column. +The "Build Novel Project" tool has a switch to ignore this flag if you need to collectively override these settings. ************** Export Formats ************** -Currently, five formats are supported for exporting. +Currently, six formats are supported for exporting. OpenDocument Format =================== -This is produces an open document odt file. +This is produces an open document ``.odt`` file. The document produced has very little formatting, and may require further editing afterwards. For a better formatted office document, you may get a better result with exporting to HTML and the import that HTML document in your office word processor. @@ -79,6 +85,12 @@ This is simply a concatenation of the files selected by the filters. The files in the project are stacked together in the order they appear in the tree view, with comments, tags, etc. included if they are selected. This is a useful format for exporting the project for later import back into novelWriter. +Standard Markdown +================= + +If you have Qt 5.14 or higher, the option to export to plain Markdown is available. +This feature uses Qt's own Markdown export feature. + Plain Text ========== diff --git a/docs/source/interface.rst b/docs/source/interface.rst index c6e1cdd6..8a2c140b 100644 --- a/docs/source/interface.rst +++ b/docs/source/interface.rst @@ -5,6 +5,9 @@ User Interface The user interface is kept as simple as possible to avoid distractions when writing. The main window contains a tree view pane with the entire structure of the project, and a small details panel below it to display additional information about the currently selected item. +Edit View +========= + Editing a document can be done by either double-clicking on it, or hitting the return key when a file is selected. This will open the document editor, which uses a simplified markdown format, described in the section below. @@ -20,6 +23,12 @@ In the view panel, the references become clickable links, and the "Referenced By The "Referenced By" panel relies on an up-to-date index of the project. If anything is missing, or seems wrong, the index can always be rebuilt from :menuselection:`Tools --> Rebuild Index` or by pressing :kbd:`F9`. +Both the document editor and the viewer will show the label of the document as set in the Project Tree. +Optionally, the full project path to the file can be shown. +This can be set the Preferences. + +Clicking on the document title bar will select and reveal the file in the Project Tree, making it easier to find the project location of the file in a large project. + Markdown Format =============== @@ -28,21 +37,23 @@ That is, it supports basic formatting like bold, italics and underline, as well The formats are listed below. In addition to these standard markdown features, the editor also allows for comments, that is text that is ignored by the word counter and not exported or, optionally, hidden in the document viewer. +If the first word of a comment is "Synopsis:" (with the colon), the comment is treated specially, and will show up in the Outline View. The editor also has a minimal set of keywords used for setting tags and references between files. .. csv-table:: Formatting Syntax :header: "Format", "Description" :widths: 15, 50 - "``# Title``", "Heading level one. The space after the # is mandatory." - "``## Title``", "Heading level two. The space after the # is mandatory." - "``### Title``", "Heading level three. The space after the # is mandatory." - "``#### Title``", "Heading level four. The space after the # is mandatory." - "``**text**``", "The text is rendered as bold text." - "``_text_``", "The text is rendered as italicized text." - "``__text__``", "The text is rendered as underlined text." - "``% text...``", "A comment. The text is not exported, seen in viewer, or counted towards word counts." - "``@keyword: value``", "A keyword argument followed by a value, or a comma separated list of values." + "``# Title``", "Heading level one. The space after the # is mandatory." + "``## Title``", "Heading level two. The space after the # is mandatory." + "``### Title``", "Heading level three. The space after the # is mandatory." + "``#### Title``", "Heading level four. The space after the # is mandatory." + "``**text**``", "The text is rendered as bold text." + "``_text_``", "The text is rendered as italicized text." + "``__text__``", "The text is rendered as underlined text." + "``% text...``", "A comment. The text is not exported by default, seen in viewer, or counted towards word counts." + "``% Synopsis: text...``", "A synopsis comment. Shows up in the Synopsis column of the Outline View, but is otherwise treated as a comment." + "``@keyword: value``", "A keyword argument followed by a value, or a comma separated list of values." The editor and viewer also supports markdown standard hard line breaks, and preserves non-breaking spaces. A hard line break is achieved by leaving two or more spaces at the end of the line. @@ -97,6 +108,7 @@ These are as following: ":kbd:`Alt-2`", "Switch focus to document editor pane." ":kbd:`Alt-3`", "Switch focus to document viewer pane." ":kbd:`Ctrl-.`", "Correct word under cursor." + ":kbd:`Ctrl-,`", "Open the Preferences dialog." ":kbd:`Ctrl-/`", "Change block format to comment." ":kbd:`Ctrl-0`", "Remove block formatting for block under cursor." ":kbd:`Ctrl-1`", "Change block format to header level 1." @@ -115,9 +127,8 @@ These are as following: ":kbd:`Ctrl-N`", "Create new document." ":kbd:`Ctrl-O`", "Open selected document." ":kbd:`Ctrl-Q`", "Exit novelWriter." - ":kbd:`Ctrl-R`", "If in tree view, open a document for viewing. If in editor pane, open current document for viewing." + ":kbd:`Ctrl-R`", "If in tree view, open a document for viewing. If editor pane has focus, open current document for viewing." ":kbd:`Ctrl-S`", "Save the current document in the editor." - ":kbd:`Ctrl-T`", "Show project timeline." ":kbd:`Ctrl-U`", "Format selected text, or word under cursor, as underline." ":kbd:`Ctrl-V`", "Paste text from clipboard to cursor position." ":kbd:`Ctrl-W`", "Close the current document in the editor." @@ -128,12 +139,12 @@ These are as following: ":kbd:`Ctrl-F10`", "Toggle automatic updating of project outline." ":kbd:`Ctrl-Del`", "If in tree view, move a document to trash, or delete a folder." ":kbd:`Ctrl-Enter`", "Open the tag or reference under the cursor in the view panel." - ":kbd:`Ctrl-Shift-,`", "Change project settings." + ":kbd:`Ctrl-Shift-,`", "Open the Project Settings dialog." ":kbd:`Ctrl-Shift-/`", "Remove block formatting for block under cursor." ":kbd:`Ctrl-Shift-1`", "Replace occurrence of word in current document, and search for next occurrence." ":kbd:`Ctrl-Shift-A`", "Select all text in current paragraph." ":kbd:`Ctrl-Shift-D`", "Wrap selected text, or word under cursor, in single quotes." - ":kbd:`Ctrl-Shift+G`", "Find previous occurrence of word in current document. (Same as :kbd:`Shift-F3`" + ":kbd:`Ctrl-Shift-G`", "Find previous occurrence of word in current document. (Same as :kbd:`Shift-F3`" ":kbd:`Ctrl-Shift-I`", "Import text to the current document from a text file." ":kbd:`Ctrl-Shift-N`", "Create new folder." ":kbd:`Ctrl-Shift-O`", "Open a project." @@ -142,13 +153,13 @@ These are as following: ":kbd:`Ctrl-Shift-W`", "Close the current project." ":kbd:`Ctrl-Shift-Up`", "Move item one step up in the tree view." ":kbd:`Ctrl-Shift-Down`", "Move item one step down in the tree view." - ":kbd:`F1`", "Open documentation." + ":kbd:`F1`", "Open documentation. This just tries to send the documentation URL ti your browser." ":kbd:`F2`", "If in tree view, edit a document or folder settings. (Same as :kbd:`Ctrl-E`)" ":kbd:`F3`", "Find next occurrence of word in current document. (Same as :kbd:`Ctrl-G`)" - ":kbd:`F5`", "Export project dialog." + ":kbd:`F5`", "Open the Build Novel Project dialog." ":kbd:`F7`", "Re-run spell checker." ":kbd:`F8`", "Activate Zen Mode, hiding project tree and view panel." - ":kbd:`F9`", "Re-build project indices." + ":kbd:`F9`", "Re-build project index." ":kbd:`F10`", "Re-build project outline." ":kbd:`F11`", "Activate full screen mode." ":kbd:`Shift-Enter`", "Insert a hard line break at the cursor position." diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst index ad7117f1..13a83323 100644 --- a/docs/source/introduction.rst +++ b/docs/source/introduction.rst @@ -37,10 +37,9 @@ Project Export -------------- The project can at any time be exported to a range of different formats. -Natively, novelWriter supports export to plain text file, html5 document, LaTeX source file, novelWriter flavoured markdown, and standard markdown. -Additional export options are available through `Pandoc `_. -Currently, novelWriter will assist in converting the project to Open Office documents, Word documents, and epub. -However, to be able to fully take advantage of the many features of Pandoc, you may want to run it yourself and use the novelWriter html or markdown export as input. +Natively, novelWriter supports export to plain text file, HTML document, novelWriter flavoured markdown, standard markdown (requires Qt 5.14), and to a basic Open Document. +In addition, printing and printing to PDF is also possible. +The best supported export format is HTML, which can be imported or converted by a number of other tools like Pandoc, or simply imported into Libre Office and similar. Screenshot ---------- diff --git a/docs/source/notes.rst b/docs/source/notes.rst index 4e31b2a9..5947ea3f 100644 --- a/docs/source/notes.rst +++ b/docs/source/notes.rst @@ -9,9 +9,9 @@ These are not required, but making at least minimal files for each such element, File Tags ========= -Each note file can have a tag associated with it, +Each new heading in a note file can have a tag associated with it. The format of a tag is ``@tag: tagname``, where tagname is a unique identifier. -Tags can then be referenced in the novel files and will show up in the Outline View. +Tags can then be referenced in the novel files, or other note files, and will show up in the Outline View and in the back-reference panel when a document is being viewed. The syntax highlighter will alert the user that the keyword is correctly used and that the tag is allowed, that is, the tag is unique. Duplicate tags should be detected as long as the index is up to date. diff --git a/docs/source/projects.rst b/docs/source/projects.rst index 44600b56..f712891f 100644 --- a/docs/source/projects.rst +++ b/docs/source/projects.rst @@ -7,25 +7,28 @@ See the Technical Information section for further details. A new project can be created from the Project menu by selecting :menuselection:`Project --> New Project`. A list of recently opened projects is maintained, and displayed in the "Open Project" dialog. +A project can be removed from this list by selecting it and pressing the :kbd:`Del` key. The project specific settings are available in :menuselection:`Project --> Project Settings`. See further details below. -Project Structure -================= +Project Roots +============= Projects are structured into a set of root folders, visible in the left side tree view panel. The core novel files go into a root folder of type "Novel". -Other supporting files go into root folders of types "Plot", "Characters", "Locations", "Timeline", "Objects", "Entities" or "Custom". +Other supporting files go into root folders of types "Plot", "Characters", "Locations", "Timeline", "Objects", "Entities", or "Custom". These other root folder types are intended for your notes on the various elements of your story. Using these is of course entirely optional. A new project will not have all of the root folders present, but you can add the ones you want from :menuselection:`Project --> Create Root Folder`. -The root folders are intended for the following use, but aside from the Novel folder, no restrictions apply. +The root folders are intended for the following use, but aside from the Novel folder, no restrictions are enforced by the application. You can use them however you want. -The root folders correspond to the categories of tags that can be used. -See the "Project Structure" section for further details. + +.. note:: + The root folders correspond to the categories of tags that can be used. + See the "Project Structure" section for further details. * **Novel:** The root folder of all text that goes into the final novel. This class of files have other rules and features than other files in the project. @@ -47,18 +50,20 @@ Orphaned Documents ------------------ In the event the editor crashes or otherwise exits without saving the project state, files that have been added to the project tree and are saved to disk will appear in a special "Orphaned Items" root folder next time the application is started. -These orphaned files will not have any meta data associated with them, although novelWriter will try to restore the file label it had in the project tree. Other information will have to be set again, and the files moved back to the correct location in the project. +These orphaned files will not have any meta data associated with them, although novelWriter will try to restore the file label it had in the project tree. +Other information will have to be set again, and the files moved back to the correct location in the project. Project Lockfile ---------------- To prevent orphaned files caused by file conflicts when novelWriter projects are synced with file synchronisation tools, a project lockfile is written to the project folder. -If you try to open a project which has such a file, you will be presented with a warning, and some information about where the project is potentially open. +If you try to open a project which has such a file, you will be presented with a warning, and some information about where novelWriter thinks the project is open. You will be give the option to ignore this warning, and continue opening the project. -However, if multiple instances are in fact editing the same project, you are likely to cause inconsistencies and create diverging project files. +However, if multiple instances are in fact editing the same project, you are likely to cause inconsistencies and create diverging project files, potentially resulting in loss of data. .. note:: - If, for some reason, novelWriter crashes, the lock file may remain. If so, it is safe to ignore the lock file warning when re-opening the project. + If, for some reason, novelWriter crashes, the lock file may remain. + In such a case it is safe to ignore the lock file warning when re-opening the project. Using Folders in the Project Tree --------------------------------- @@ -84,6 +89,12 @@ The Book Title is currently not ues for anything, so setting it is just for the The Book Authors text box takes one author per line. +Details Tab +----------- + +This tab presents an overview of meta data about the project. +It states where on your file system the project is saved, how may times it has been saved, how many folders and files it contains, and how many words exist in the entire project. + Status Tab ---------- @@ -126,6 +137,8 @@ This dialog can also be opened again later from either the menu, :menuselection: The layout of the file is also defined here. For Novel files, the full list of layout options are available. For non-Novel files, only "Note" is available. +You can also select whether the file is by default included when building the project. +This setting can be overridden in the export tool if you wish to include them anyway. See the Project Structure section for more details. @@ -133,7 +146,7 @@ Backup ====== An automatic backup system is built into novelWriter. -In order to use it, a backup path to where the backups are to be stored needs to be provided in :menuselection:`Tools --> Preferences`. +In order to use it, a backup path to where the backups are to be stored must to be provided in :menuselection:`Tools --> Preferences`. Backups can be run automatically when a project is closed, which also implies it is run when the application is closed. Backups are date stamped zip files of the entire project folder, and are stored in a subfolder of the backup path with the same name as the project working title set in Project Settings. diff --git a/docs/source/started.rst b/docs/source/started.rst index 59a7f550..bd6684be 100644 --- a/docs/source/started.rst +++ b/docs/source/started.rst @@ -4,12 +4,7 @@ Getting Started You can download novelWriter from https://github.com/vkbo/novelWriter/releases -Latest version is |version|: - -* ZIP file: https://github.com/vkbo/novelWriter/archive/v0.6.1.zip -* TAR file: https://github.com/vkbo/novelWriter/archive/v0.6.1.tar.gz - -Extract the archive to a location of your choice. +Latest version is |version|. Installing Dependencies ======================= @@ -36,8 +31,8 @@ The following are optional, but recommended: * ``pyenchant`` for spell checking PyQt/Qt should be at least 5.2.1, but ideally 5.10 or higher for nearly all features to work. -Exporting to markdown requires PyQt/Qt 5.14. -There are no known minimum for lxml, but the code was originally written with 4.2. +Exporting to standard Markdown requires PyQt/Qt 5.14. +There are no known minimum for package lxml, but the code was originally written with 4.2. The optional spell check library must be at least 3.0.0 to work with Windows. On Linux, 2.0.0 also works fine. @@ -59,6 +54,8 @@ To list all options, run: python novelWriter.py --help +There are also a couple of install scripts in the assets folder which will assist in setting up launch icon and the novelWriter project file mimetype for Gnome desktops on Linux. +Currently, there's one script for Debian and one for Ubuntu. Building a Standalone Executable ================================ diff --git a/docs/source/structure.rst b/docs/source/structure.rst index ddc28def..197a18e1 100644 --- a/docs/source/structure.rst +++ b/docs/source/structure.rst @@ -33,10 +33,12 @@ Each partition, indicated by a heading, can contain references to tags set in th The references are gathered by the indexer and used to generate the Outline View of how the different parts of the novel are connected. References and tags are also clickable in the view panel, and makes it easy to navigate reference notes while writing. -For setting the targets of references, see the "Supporting Files" section. +The targets of references can also be set per header. +This is covered in the "Supporting Files" section. References are set as keyword and a list of corresponding tags. -The valid keywords are listed below. The format of such a line is ``@keyword: value1, [value2] ... [valueN]``. +The valid keywords are listed below. +The format of a meta line is ``@keyword: value1, [value2] ... [valueN]``. All keywords allow multiple values. * ``@pov``: The point-of-view character for the current section. @@ -64,29 +66,53 @@ In general, the index for a file is regenerated when a file is saved, so this sh Novel File Layout ================= -Files that exist under the Novel type root folder can have a number of layouts set. -See overview below. +Files in a novelWriter project can have a layout format set. These layouts are important when the project is exported, as they indicate how to treat the content in terms of formatting, headings and page breaks. -the layout selected also shows up as flags in the tree view, making it easier to track what kind of files they are. +The layout for each file is indicated as the last set of characters in the Flags column of the project tree. +They also help to indicate what each file is for in your project. + +Some of these layout types are different, some are just cosmetic. +The "Book" layout is a generic novel file layout that in formatting is identical to "Chapter" and "Scene", but may help to indicate what files do in your project. +You can lay out your project using Book files for each act, and then later split those into chapter or scene files by using the "Split Document" tool. +Scenes can also be contained within chapter files, but you lose the drag and drop feature that comes with having them in separate files. + +Some layouts have implications on how the project is exported. +Files with layout "Title" and "Partition" have all headings and text centred, while the "Unnumbered" layout disables the automatic chapter numbering feature for everything contained within it. + +All of the above layout formats are only usable in the Novel root folder. +Files that are not a part of the novel itself should have the Note layout. +These files are not getting any special formatting, and it is possible to collectively filter them out during export. +Note files can be used anywhere in the project. + +Below is an overview of all available layout formats. * **Title Page**: The title page layout. The title should be formatted as a heading level one. -* **Book**: In principle, the entire novel can be contained in a single file. - In that case, use the Book layout on this file. - The internal structure is then controlled by the heading levels. -* **Plain Page**: A plain page is just that, - It is not included into content and the heading levels are ignored. -* **Partition**: A partition can be used to split a the novel into parts. - Use a level one heading for this. + All text is automatically centred on exports. +* **Plain Page**: A plain page layout useful for instance for front matter pages. + Heading levels are ignored for this layout format, and so are formatting options like Justify Text. + The page is exported with a page break before it. +* **Book**: This is the generic novel file format that in principle can be used for all novel files. + Since the internal structure of the novel is controlled by the heading levels, this file will produce the same result as a collection of Partition, Chapter and Scene type files. + However, it does not provide the functionality of the Unnumbered layout format. +* **Partition**: A partition can be used to split the novel into parts. + Partition titles are indicated with a level one heading. + You can also add text and meta data to the page. + The Partition file layout will in addition force a page break before the heading, and centre all content on the page. * **Chapter**: Signifies the start of a new chapter. - If the text itself is contained in scene files, these files should only contain the title and tag references for characters, plot, etc. + If the text itself is contained in scene files, these files should only contain the title, comments, synopsis, and tag references for characters, plot, etc. The heading for chapters should be level two. + If you need an opening text, like a quote or other leading text before the first scene, this is also where you'd want to add this text. * **Unnumbered**: Same as Chapter, but when exporting the files and automatic chapter numbering is enabled, this file will not receive a number. + This makes the layout suitable for Prologue and Epilogue type chapters. * **Scene**: A scene file. This file should have a header of level three. - Further sections can have headers of level four. - These will not impact the overall structure, but will allow for setting new characters and plot references in parts of a scene if such granularity is needed. + Further sections can have headers of level four, but there are no file layout specifically for sections. * **Note**: A generic file that is optionally ignored when the novel is exported. + Use these files for descriptions of content in the supporting root folders. + Note files can also be added to the Novel root folder if you need to insert notes there. + Note file headers receive no formatting when building the project. + They are always exported as-is. .. note:: The layout granularity is entirely optional. diff --git a/docs/source/technical.rst b/docs/source/technical.rst index 9e358a38..32d79545 100644 --- a/docs/source/technical.rst +++ b/docs/source/technical.rst @@ -9,23 +9,23 @@ How Data is Stored All novelWriter files are written with utf-8 encoding. Since Python automatically converts Unix line endings to Windows line endings on Windows systems, novelWriter does not make any adaptations to the formatting on Windows systems. +This is handled entirely by the Python standard library. Main Project File ----------------- -The project itself requires a dedicated folder for storing its files. -The main project file is stored as an XML file with the name ``nwProject.nwx``. -This file contains all the meta data required for the project. -That includes project-specific settings. +The project itself requires a dedicated folder for storing its files, where novelWriter will create its own "file system" where the folder and file hierarchy is described in a project XML file. +This is the main project file in the project's root folder with the name ``nwProject.nwx``. +This file also contains all the meta data required for the project, and a number of related project settings. If this file is lost or corrupted, the structure of the project is lost. It is important to keep this file backed up, either through the built-in backup tool, or your own backup solution. .. note:: The novelWriter project folder is structured so that it can easily be added to a version control system like git. - If so, you may want to add a `.gitignore` file to exclude files with the extensions `.bak` and `.json`. + If so, you may want to add a `.gitignore` file to exclude files with the extensions `.json` as JSON files are used to cache the index and various run-time settings. -The project XML file is suitable for diff tools and version control, although a timesetamp is set in the meta section on line 2 each time the file is saved. +The project XML file is indent-formatted, suitable for diff tools and version control, although a timesetamp is set in the meta section on line 2 each time the file is saved. Project Documents ----------------- @@ -40,16 +40,16 @@ The file meta data in the tree view, except the file label, is only saved in the Each document file contains a plain text version of the text from the editor. The file can in principle be edited in any text editor, and is suitable for diffing and version control if so desired. -Just make sure the file remains in utf-8 encoding, otherwise unicode chatracters may become mangled. +Just make sure the file remains in utf-8 encoding, otherwise unicode chatracters may become mangled when opened in novelWriter again. -The first line contains some meta data starting with the characters "%%~". +The first line of the file contains some meta data starting with the characters "%%~". This line is mainly there to restore some information if it is lost from the project file, and the information may be helpful if you do open the file in an external editor as it contains the file label as the last entry. -The line can be deleted without any consequences to the rest of the content of the file. +The line can be deleted without any consequences to the rest of the content of the file, and will be added back next time the file is saved in novelWriter. The File Saving Process ----------------------- When saving the project file, or any of the documents, the data is first saved to a temporary file. -If successful, the old data file is renamed with a `.bak` extension, and the temporary file becomes the new file. +If successful, the old data file is removed, and the temporary file becomes the new file. This ensures that the previously saved data is only replaced when the new data has been successfully saved. -The `.bak` file will always contain the previous version of the file, although when auto-save is enabled, they may have the same content. +For the project XML file, a `.bak` file is kept which will always contain the previous version of the file, although when auto-save is enabled, they may have the same content.