From cdf3c62d1725d0f835b0b995672c6b50fbd12124 Mon Sep 17 00:00:00 2001 From: "Veronica K. B. Olsen" <1619840+vkbo@users.noreply.github.com> Date: Sat, 16 Jan 2021 17:41:40 +0100 Subject: [PATCH] Reformat and update the source file header docstrings --- nw/common.py | 37 ++++++++++++++--------------- nw/config.py | 37 ++++++++++++++--------------- nw/constants/constants.py | 37 ++++++++++++++--------------- nw/constants/enum.py | 37 ++++++++++++++--------------- nw/constants/iso.py | 37 ++++++++++++++--------------- nw/core/document.py | 37 ++++++++++++++--------------- nw/core/index.py | 37 ++++++++++++++--------------- nw/core/item.py | 37 ++++++++++++++--------------- nw/core/options.py | 39 +++++++++++++++---------------- nw/core/project.py | 37 ++++++++++++++--------------- nw/core/spellcheck.py | 37 ++++++++++++++--------------- nw/core/status.py | 37 ++++++++++++++--------------- nw/core/tohtml.py | 37 ++++++++++++++--------------- nw/core/tokenizer.py | 37 ++++++++++++++--------------- nw/core/tools.py | 43 +++++++++++++++++----------------- nw/core/tree.py | 37 ++++++++++++++--------------- nw/error.py | 37 ++++++++++++++--------------- nw/gui/about.py | 37 ++++++++++++++--------------- nw/gui/build.py | 37 ++++++++++++++--------------- nw/gui/custom.py | 41 ++++++++++++++++---------------- nw/gui/doceditor.py | 49 +++++++++++++++++++-------------------- nw/gui/dochighlight.py | 37 ++++++++++++++--------------- nw/gui/docmerge.py | 37 ++++++++++++++--------------- nw/gui/docsplit.py | 37 ++++++++++++++--------------- nw/gui/docviewer.py | 45 ++++++++++++++++++----------------- nw/gui/itemdetails.py | 35 ++++++++++++++-------------- nw/gui/itemeditor.py | 37 ++++++++++++++--------------- nw/gui/mainmenu.py | 37 ++++++++++++++--------------- nw/gui/outline.py | 37 ++++++++++++++--------------- nw/gui/outlinedetails.py | 37 ++++++++++++++--------------- nw/gui/preferences.py | 37 ++++++++++++++--------------- nw/gui/projload.py | 37 ++++++++++++++--------------- nw/gui/projsettings.py | 37 ++++++++++++++--------------- nw/gui/projtree.py | 39 +++++++++++++++---------------- nw/gui/projwizard.py | 37 ++++++++++++++--------------- nw/gui/statusbar.py | 37 ++++++++++++++--------------- nw/gui/theme.py | 39 +++++++++++++++---------------- nw/gui/writingstats.py | 37 ++++++++++++++--------------- nw/guimain.py | 37 ++++++++++++++--------------- 39 files changed, 719 insertions(+), 758 deletions(-) diff --git a/nw/common.py b/nw/common.py index f0e5900e..1b36c6a7 100644 --- a/nw/common.py +++ b/nw/common.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter Common Functions +""" +novelWriter – Common Functions +============================== +Various common functions - novelWriter – Common Functions -================================ - Various functions used multiple places +File History: +Created: 2019-05-12 [0.1.0] - File History: - Created: 2019-05-12 [0.1.0] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import logging diff --git a/nw/config.py b/nw/config.py index ddec796f..a0fd6847 100644 --- a/nw/config.py +++ b/nw/config.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter Config Class +""" +novelWriter – Config Class +========================== +Class holding the user preferences and handling the config file - novelWriter – Config Class -============================ - Class reading and holding the preferences of the application +File History: +Created: 2018-09-22 [0.0.1] - File History: - Created: 2018-09-22 [0.0.1] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import logging diff --git a/nw/constants/constants.py b/nw/constants/constants.py index a39bb8e1..e59734f8 100644 --- a/nw/constants/constants.py +++ b/nw/constants/constants.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter Constants +""" +novelWriter – Constants +======================= +Constants and maps for translating flags and enums to text - novelWriter – Constants -========================= - Constants for translating flags and enums to text +File History: +Created: 2019-04-28 [0.0.1] - File History: - Created: 2019-04-28 [0.0.1] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ from nw.constants.enum import ( diff --git a/nw/constants/enum.py b/nw/constants/enum.py index 7079ce6e..072eec6c 100644 --- a/nw/constants/enum.py +++ b/nw/constants/enum.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter Enums +""" +novelWriter – Enums +=================== +Global enum values - novelWriter – Enums -===================== - All enum values +File History: +Created: 2018-11-02 [0.0.1] - File History: - Created: 2018-11-02 [0.0.1] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ from enum import Enum diff --git a/nw/constants/iso.py b/nw/constants/iso.py index 4cc83bcd..94c6ef81 100644 --- a/nw/constants/iso.py +++ b/nw/constants/iso.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter ISO Codes +""" +novelWriter – ISO Codes +======================= +Handles translating language codes to language names - novelWriter – ISO Codes -========================= - Handles translating language codes to language names +File History: +Created: 2019-11-05 [0.4.0] - File History: - Created: 2019-11-05 [0.4.0] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ class isoLanguage(): diff --git a/nw/core/document.py b/nw/core/document.py index e7ed46ba..7e833854 100644 --- a/nw/core/document.py +++ b/nw/core/document.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter Project Document +""" +novelWriter – Project Document +============================== +Data class for a single novelWriter document - novelWriter – Project Document -================================ - Class holding a single novelWriter document +File History: +Created: 2018-09-29 [0.0.1] - File History: - Created: 2018-09-29 [0.0.1] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import logging diff --git a/nw/core/index.py b/nw/core/index.py index d1851f5b..d249c004 100644 --- a/nw/core/index.py +++ b/nw/core/index.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter Project Index +""" +novelWriter – Project Index +=========================== +Data class for the project index of tags, headers and references - novelWriter – Project Index -============================= - Class holding the project index of tags, headers and references +File History: +Created: 2019-05-27 [0.1.4] - File History: - Created: 2019-05-27 [0.1.4] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import nw diff --git a/nw/core/item.py b/nw/core/item.py index 2ac93c42..e2a5a4e8 100644 --- a/nw/core/item.py +++ b/nw/core/item.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter Project Item Class +""" +novelWriter – Project Item Class +================================ +Data class for a project tree item - novelWriter – Project Item Class -================================== - Class holding the data of a project tree item +File History: +Created: 2018-10-27 [0.0.1] - File History: - Created: 2018-10-27 [0.0.1] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import logging diff --git a/nw/core/options.py b/nw/core/options.py index db94ae45..d95e5e6f 100644 --- a/nw/core/options.py +++ b/nw/core/options.py @@ -1,29 +1,28 @@ # -*- coding: utf-8 -*- -"""novelWriter Project Options Cache +""" +novelWriter – Project Options Cache +=================================== +Data class for user-defined GUI project options - novelWriter – Project Options Cache -===================================== - Class wrapping the project options state +File History: +Created: 2019-10-21 [0.3.1] +Rewritten: 2020-02-19 [0.4.5] - File History: - Created: 2019-10-21 [0.3.1] - Rewritten: 2020-02-19 [0.4.5] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import logging diff --git a/nw/core/project.py b/nw/core/project.py index 75d86aaa..4e1739f4 100644 --- a/nw/core/project.py +++ b/nw/core/project.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter Project Wrapper +""" +novelWriter – Project Wrapper +============================= +Data class for novelWriter projects - novelWriter – Project Wrapper -=============================== - Class wrapping the data of a novelWriter project +File History: +Created: 2018-09-29 [0.0.1] - File History: - Created: 2018-09-29 [0.0.1] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import nw diff --git a/nw/core/spellcheck.py b/nw/core/spellcheck.py index 8e71831c..8b3807fa 100644 --- a/nw/core/spellcheck.py +++ b/nw/core/spellcheck.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter Spell Check Classes +""" +novelWriter – Spell Check Classes +================================= +Wrapper classes for spell checking tools - novelWriter – Spell Check Classes -=================================== - Wrapper class for spell checking tools +File History: +Created: 2019-06-11 [0.1.5] - File History: - Created: 2019-06-11 [0.1.5] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import nw diff --git a/nw/core/status.py b/nw/core/status.py index 71e2f8e4..cf0f9fab 100644 --- a/nw/core/status.py +++ b/nw/core/status.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter Project Item Status Class +""" +novelWriter – Project Item Status Class +======================================= +Data class for the status/importance settings of a project item - novelWriter – Project Item Status Class -========================================= - Class holding the status/importance elements of a project item +File History: +Created: 2019-05-19 [0.1.3] - File History: - Created: 2019-05-19 [0.1.3] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import logging diff --git a/nw/core/tohtml.py b/nw/core/tohtml.py index 55da29d1..83e07ffa 100644 --- a/nw/core/tohtml.py +++ b/nw/core/tohtml.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter HTML Text Converter +""" +novelWriter – HTML Text Converter +================================= +Extends the Tokenizer class to generate HTML output - novelWriter – HTML Text Converter -=================================== - Extends the Tokenizer class to write HTML +File History: +Created: 2019-05-07 [0.0.1] - File History: - Created: 2019-05-07 [0.0.1] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import logging diff --git a/nw/core/tokenizer.py b/nw/core/tokenizer.py index 2e7d0c6e..5f1aa40e 100644 --- a/nw/core/tokenizer.py +++ b/nw/core/tokenizer.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter Text Tokenizer +""" +novelWriter – Text Tokenizer +============================ +Splits a piece of novelWriter markdown text into its elements - novelWriter – Text Tokenizer -============================== - Splits a piece of novelWriter markdown text into its elements +File History: +Created: 2019-05-05 [0.0.1] - File History: - Created: 2019-05-05 [0.0.1] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import logging diff --git a/nw/core/tools.py b/nw/core/tools.py index 9e8229e3..44b4c865 100644 --- a/nw/core/tools.py +++ b/nw/core/tools.py @@ -1,31 +1,30 @@ # -*- coding: utf-8 -*- -"""novelWriter Various Tools +""" +novelWriter – Various Tools +=========================== +Various core tool functions - novelWriter – Various Tools -============================= - Various core tool functions +File History: +Created: 2019-04-22 [0.0.1] countWords +Created: 2019-10-13 [0.2.3] numberToWord, _numberToWordEN +Merged: 2020-05-08 [0.4.5] All of the above into this file +Created: 2020-07-05 [0.10.0] numberToRoman - File History: - Created: 2019-04-22 [0.0.1] countWords - Created: 2019-10-13 [0.2.3] numberToWord, _numberToWordEN - Merged: 2020-05-08 [0.4.5] All of the above into this file - Created: 2020-07-05 [0.10.0] numberToRoman +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import logging diff --git a/nw/core/tree.py b/nw/core/tree.py index d559d91b..6d15b123 100644 --- a/nw/core/tree.py +++ b/nw/core/tree.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter Project Tree Class +""" +novelWriter – Project Tree Class +================================ +Data class for the project's tree of project items - novelWriter – Project Tree Class -================================== - Class holding the project's tree of project items +File History: +Created: 2020-05-07 [0.4.5] - File History: - Created: 2020-05-07 [0.4.5] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import logging diff --git a/nw/error.py b/nw/error.py index 586d1a1b..1f879e37 100644 --- a/nw/error.py +++ b/nw/error.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter Exception Handling +""" +novelWriter – Exception Handling +================================ +Error handling function and error dialog - novelWriter – Exception Handling -================================== - Error handling functions +File History: +Created: 2020-08-02 [0.10.2] - File History: - Created: 2020-08-02 [0.10.2] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ from PyQt5.QtCore import Qt diff --git a/nw/gui/about.py b/nw/gui/about.py index fe73387f..d584cb25 100644 --- a/nw/gui/about.py +++ b/nw/gui/about.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter GUI About Box +""" +novelWriter – GUI About Box +=========================== +The about novelWriter dialog box - novelWriter – GUI About Box -============================= - The about novelWriter dialog box +File History: +Created: 2020-05-21 [0.5.2] - File History: - Created: 2020-05-21 [0.5.2] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import nw diff --git a/nw/gui/build.py b/nw/gui/build.py index 9cfa7085..c12be8b9 100644 --- a/nw/gui/build.py +++ b/nw/gui/build.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter GUI Build Novel Project +""" +novelWriter – GUI Build Novel Project +===================================== +GUI classes for the build novel project dialog - novelWriter – GUI Build Novel Project -======================================= - Class holding the build novel project dialog +File History: +Created: 2020-05-09 [0.5] - File History: - Created: 2020-05-09 [0.5] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import nw diff --git a/nw/gui/custom.py b/nw/gui/custom.py index 1658d5f1..0f989578 100644 --- a/nw/gui/custom.py +++ b/nw/gui/custom.py @@ -1,30 +1,29 @@ # -*- coding: utf-8 -*- -"""novelWriter Custom Widgets and Layouts +""" +novelWriter – Custom Widgets and Layouts +======================================== +Various custom widget and layout classes - novelWriter – Custom Widgets and Layouts -========================================== - Various custom widget and layout classes +File History: +Created: 2020-05-03 [0.4.5] QConfigLayout +Created: 2020-05-03 [0.4.5] QSwitch +Created: 2020-05-17 [0.5.1] PagedDialog - File History: - Created: 2020-05-03 [0.4.5] QConfigLayout - Created: 2020-05-03 [0.4.5] QSwitch - Created: 2020-05-17 [0.5.1] PagedDialog +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import nw diff --git a/nw/gui/doceditor.py b/nw/gui/doceditor.py index 3421276c..85d57ac4 100644 --- a/nw/gui/doceditor.py +++ b/nw/gui/doceditor.py @@ -1,34 +1,33 @@ # -*- coding: utf-8 -*- -"""novelWriter GUI Document Editor +""" +novelWriter – GUI Document Editor +================================= +GUI classes for the main document editor - novelWriter – GUI Document Editor -=================================== - Class holding the main document editor +File History: +Created: 2018-09-29 [0.0.1] GuiDocEditor +Created: 2019-04-22 [0.0.1] BackgroundWordCounter +Created: 2019-09-29 [0.2.1] GuiDocEditSearch +Created: 2020-04-25 [0.4.5] GuiDocEditHeader +Rewritten: 2020-06-15 [0.9.0] GuiDocEditSearch +Created: 2020-06-27 [0.10.0] GuiDocEditFooter +Rewritten: 2020-10-07 [1.0b3] BackgroundWordCounter - File History: - Created: 2018-09-29 [0.0.1] GuiDocEditor - Created: 2019-04-22 [0.0.1] BackgroundWordCounter - Created: 2019-09-29 [0.2.1] GuiDocEditSearch - Created: 2020-04-25 [0.4.5] GuiDocEditHeader - Rewritten: 2020-06-15 [0.9.0] GuiDocEditSearch - Created: 2020-06-27 [0.10.0] GuiDocEditFooter - Rewritten: 2020-10-07 [1.0b3] BackgroundWordCounter +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import nw diff --git a/nw/gui/dochighlight.py b/nw/gui/dochighlight.py index d06d1175..4e0ac4a0 100644 --- a/nw/gui/dochighlight.py +++ b/nw/gui/dochighlight.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter GUI Document Highlighter +""" +novelWriter – GUI Syntax Highlighter +==================================== +Class for the main document editor syntax highlighter - novelWriter – GUI Document Highlighter -======================================== - Subclass for the main editor syntax highlighting +File History: +Created: 2019-04-06 [0.0.1] - File History: - Created: 2019-04-06 [0.0.1] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import nw diff --git a/nw/gui/docmerge.py b/nw/gui/docmerge.py index 54dc1811..d3004ec1 100644 --- a/nw/gui/docmerge.py +++ b/nw/gui/docmerge.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter GUI Doc Merge +""" +novelWriter – GUI Doc Merge Tool +================================ +GUI class for merging multiple documents to one document - novelWriter – GUI Doc Merge -============================= - Tool for merging multiple documents to one document +File History: +Created: 2020-01-23 [0.4.3] - File History: - Created: 2020-01-23 [0.4.3] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import nw diff --git a/nw/gui/docsplit.py b/nw/gui/docsplit.py index 609168db..a06aaa67 100644 --- a/nw/gui/docsplit.py +++ b/nw/gui/docsplit.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter GUI Doc Split +""" +novelWriter – GUI Doc Split Tool +================================ +GUI class for splitting a single document into multiple documents - novelWriter – GUI Doc Split -============================= - Tool for splitting a single document into multiple documents +File History: +Created: 2020-02-01 [0.4.3] - File History: - Created: 2020-02-01 [0.4.3] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import nw diff --git a/nw/gui/docviewer.py b/nw/gui/docviewer.py index 34f5ded3..55e458bb 100644 --- a/nw/gui/docviewer.py +++ b/nw/gui/docviewer.py @@ -1,32 +1,31 @@ # -*- coding: utf-8 -*- -"""novelWriter GUI Document Viewer +""" +novelWriter – GUI Document Viewer +================================= +GUI classes for the main document viewer - novelWriter – GUI Document Viewer -=================================== - Class holding the main document viewer +File History: +Created: 2019-05-10 [0.0.1] GuiDocViewer +Created: 2019-10-31 [0.3.2] GuiDocViewDetails +Created: 2020-04-25 [0.4.5] GuiDocViewHeader +Created: 2020-06-09 [0.8.0] GuiDocViewFooter +Created: 2020-09-08 [1.0b1] GuiDocViewHistory - File History: - Created: 2019-05-10 [0.0.1] GuiDocViewer - Created: 2019-10-31 [0.3.2] GuiDocViewDetails - Created: 2020-04-25 [0.4.5] GuiDocViewHeader - Created: 2020-06-09 [0.8.0] GuiDocViewFooter - Created: 2020-09-08 [1.0b1] GuiDocViewHistory +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import nw diff --git a/nw/gui/itemdetails.py b/nw/gui/itemdetails.py index 1a48e9cb..923f509a 100644 --- a/nw/gui/itemdetails.py +++ b/nw/gui/itemdetails.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter GUI Document Details - - novelWriter – GUI Document Details +""" +novelWriter – GUI Item Details Panel ==================================== - Class holding the project tree item details panel +GUI class for the project tree item details panel - File History: - Created: 2019-04-24 [0.0.1] +File History: +Created: 2019-04-24 [0.0.1] - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import nw diff --git a/nw/gui/itemeditor.py b/nw/gui/itemeditor.py index 218accee..63f67021 100644 --- a/nw/gui/itemeditor.py +++ b/nw/gui/itemeditor.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter GUI Item Editor +""" +novelWriter – GUI Item Editor +============================= +GUI class for the item editor dialog - novelWriter – GUI Item Editor -=============================== - Class holding the item editor dialog +File History: +Created: 2019-04-27 [0.0.1] - File History: - Created: 2019-04-27 [0.0.1] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import nw diff --git a/nw/gui/mainmenu.py b/nw/gui/mainmenu.py index 554eca52..47a2f41b 100644 --- a/nw/gui/mainmenu.py +++ b/nw/gui/mainmenu.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter GUI Main Menu +""" +novelWriter – GUI Main Menu +=========================== +GUI class for the main window menu - novelWriter – GUI Main Menu -============================= - Class holding the main window menu +File History: +Created: 2019-04-27 [0.0.1] - File History: - Created: 2019-04-27 [0.0.1] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import nw diff --git a/nw/gui/outline.py b/nw/gui/outline.py index 38046576..67cd9d07 100644 --- a/nw/gui/outline.py +++ b/nw/gui/outline.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter GUI Project Outline +""" +novelWriter – GUI Project Outline +================================= +GUI class for the project outline view - novelWriter – GUI Project Outline -=================================== - Class holding the project outline view +File History: +Created: 2019-11-16 [0.4.1] - File History: - Created: 2019-11-16 [0.4.1] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import nw diff --git a/nw/gui/outlinedetails.py b/nw/gui/outlinedetails.py index 0a6dce7f..6004318a 100644 --- a/nw/gui/outlinedetails.py +++ b/nw/gui/outlinedetails.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter GUI Project Outline Details +""" +novelWriter – GUI Project Outline Details +========================================= +GUI class for the project outline details panel - novelWriter – GUI Project Outline Details -=========================================== - Class holding the project outline details panel +File History: +Created: 2020-06-02 [0.7.0] - File History: - Created: 2020-06-02 [0.7.0] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import nw diff --git a/nw/gui/preferences.py b/nw/gui/preferences.py index 90b86a88..68c5c1ba 100644 --- a/nw/gui/preferences.py +++ b/nw/gui/preferences.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter GUI Preferences +""" +novelWriter – GUI Preferences +============================= +GUI classes for the user preferences dialog - novelWriter – GUI Preferences -=============================== - Class holding the preferences dialog +File History: +Created: 2019-06-10 [0.1.5] - File History: - Created: 2019-06-10 [0.1.5] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import nw diff --git a/nw/gui/projload.py b/nw/gui/projload.py index 348e26d7..39714cbb 100644 --- a/nw/gui/projload.py +++ b/nw/gui/projload.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter GUI Open Project +""" +novelWriter – GUI Open Project +============================== +GUI class for the load/browse/new project dialog - novelWriter – GUI Open Project -================================ - Class holding the load/browse/new project dialog +File History: +Created: 2020-02-26 [0.4.5] - File History: - Created: 2020-02-26 [0.4.5] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import nw diff --git a/nw/gui/projsettings.py b/nw/gui/projsettings.py index 6521e76c..bb9d3f7d 100644 --- a/nw/gui/projsettings.py +++ b/nw/gui/projsettings.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter GUI Project Settings +""" +novelWriter – GUI Project Settings +================================== +GUI classes for the project settings dialog - novelWriter – GUI Project Settings -==================================== - Class holding the project settings dialog +File History: +Created: 2018-09-29 [0.0.1] - File History: - Created: 2018-09-29 [0.0.1] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import nw diff --git a/nw/gui/projtree.py b/nw/gui/projtree.py index 49ca0fcb..fcb5f0f4 100644 --- a/nw/gui/projtree.py +++ b/nw/gui/projtree.py @@ -1,29 +1,28 @@ # -*- coding: utf-8 -*- -"""novelWriter GUI Project Tree +""" +novelWriter – GUI Project Tree +============================== +GUI classes for the main window project tree - novelWriter – GUI project Tree -================================ - Class holding the project tree view +File History: +Created: 2018-09-29 [0.0.1] GuiProjectTree +Created: 2020-06-04 [0.7.0] GuiProjectTreeMenu - File History: - Created: 2018-09-29 [0.0.1] GuiProjectTree - Created: 2020-06-04 [0.7.0] GuiProjectTreeMenu +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import nw diff --git a/nw/gui/projwizard.py b/nw/gui/projwizard.py index 358f715c..b1d72520 100644 --- a/nw/gui/projwizard.py +++ b/nw/gui/projwizard.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter GUI New Project Wizard +""" +novelWriter – GUI New Project Wizard +==================================== +GUI classes for the new project wizard dialog - novelWriter – GUI New project Wizard -====================================== - Class holding the new project wizard dialog +File History: +Created: 2020-07-11 [0.10.1] - File History: - Created: 2020-07-11 [0.10.1] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import nw diff --git a/nw/gui/statusbar.py b/nw/gui/statusbar.py index e1738447..f17af853 100644 --- a/nw/gui/statusbar.py +++ b/nw/gui/statusbar.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter GUI Main Window StatusBar +""" +novelWriter – GUI Main Window Status Bar +======================================== +GUI class for the main window status bar - novelWriter – GUI Main Window StatusBar -========================================= - Class holding the main window status bar +File History: +Created: 2019-04-20 [0.0.1] - File History: - Created: 2019-04-20 [0.0.1] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import nw diff --git a/nw/gui/theme.py b/nw/gui/theme.py index 2b0f4608..7a231d1b 100644 --- a/nw/gui/theme.py +++ b/nw/gui/theme.py @@ -1,29 +1,28 @@ # -*- coding: utf-8 -*- -"""novelWriter Theme and Icons Classes +""" +novelWriter – Theme and Icons Classes +===================================== +Classes managing and caching themes and icons - novelWriter – Theme and Icons Classs -====================================== - Class managing and caching themes and icons +File History: +Created: 2019-05-18 [0.1.3] GuiTheme +Created: 2019-11-08 [0.4.0] GuiIcons - File History: - Created: 2019-05-18 [0.1.3] GuiTheme - Created: 2019-11-08 [0.4.0] GuiIcons +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import nw diff --git a/nw/gui/writingstats.py b/nw/gui/writingstats.py index b1eb3d42..0b5aaabb 100644 --- a/nw/gui/writingstats.py +++ b/nw/gui/writingstats.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter GUI Writing Statistics +""" +novelWriter – GUI Writing Statistics +==================================== +GUI class for the session statistics dialog - novelWriter – GUI Writing Statistics -====================================== - Class holding the word count and session statistics dialog +File History: +Created: 2019-10-20 [0.3] - File History: - Created: 2019-10-20 [0.3] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import nw diff --git a/nw/guimain.py b/nw/guimain.py index 8f209717..88eb3fb9 100644 --- a/nw/guimain.py +++ b/nw/guimain.py @@ -1,28 +1,27 @@ # -*- coding: utf-8 -*- -"""novelWriter GUI Main Window +""" +novelWriter – GUI Main Window +============================= +The main application window - novelWriter – GUI Main Window -=============================== - Class holding the main application window +File History: +Created: 2018-09-22 [0.0.1] - File History: - Created: 2018-09-22 [0.0.1] +This file is a part of novelWriter +Copyright 2018–2021, Veronica Berglyd Olsen - This file is a part of novelWriter - Copyright 2018–2021, Veronica Berglyd Olsen +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . +You should have received a copy of the GNU General Public License +along with this program. If not, see . """ import nw