Merge pull request #69 from navigating-stories/documentation

Restructure documentation and include missing information on installing the storynavigator widget

doc/index.rst

@@ -19,12 +19,41 @@ Widgets
 -------
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
+   :caption: Getting Started
 
-   widgets/actoranalysis
-   widgets/actionanalysis
-   widgets/settinganalysis
+   widgets/installation
+   widgets/usage
+   widgets/tutorials
+   widgets/knownissues
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Widgets
+
+   widgets/actions
+   widgets/actors
+   widgets/elements
    widgets/narrativenetwork
+   widgets/setting
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Developers
+
+   widgets/buildingfromsource
+   widgets/contribute
+   widgets/changelog    
+
+.. toctree::
+   :maxdepth: 2
+   :caption: About
+
+   widgets/contact   
+   widgets/howtocite
+   widgets/inaction
+   widgets/faqs
+
 
 Indices and tables
 ==================

doc/widgets.json

@@ -2,6 +2,21 @@
  [
   "Orange Story Navigator",
   [
+    {
+    "text": "Installation",
+    "doc": "widgets/install.md",
+    "icon": "../orangecontrib/storynavigation/widgets/images/storynavigator_logo.png",
+    "background": "#C0FF97",
+    "keywords": ["install", "Orange", "installation","Add-on"]
+       },
+
+    {
+     "text": "Actions Analysis",
+     "doc": "widgets/actionanalysis.md",
+     "icon": "../orangecontrib/storynavigation/widgets/icons/action_analysis_icon.png",
+     "background": "#C0FF97",
+     "keywords": ["verb tense", "verbs", "actions", "part of speech tagging"]
+       },
    {
     "text": "Actor Analysis",
     "doc": "widgets/actoranalysis.md",
@@ -10,25 +25,25 @@
     "keywords": ["part of speech tagging", "nouns", "characters", "actors"]
    },
    {
-    "text": "Actions Analysis",
-    "doc": "widgets/actionanalysis.md",
-    "icon": "../orangecontrib/storynavigation/widgets/icons/action_analysis_icon.png",
+    "text": "Elements Analysis",
+    "doc": "widgets/elements.md",
+    "icon": "../orangecontrib/storynavigation/widgets/icons/tagger_icon.png",
     "background": "#C0FF97",
-    "keywords": ["verb tense", "verbs", "actions", "part of speech tagging"]
+    "keywords": ["NLP tagging", "Custom tagging", "actions", "actors"]
+   },   
+   {
+    "text": "Narrative Network",
+    "doc": "widgets/narrativenetwork.md",
+    "icon": "../orangecontrib/storynavigation/widgets/icons/narrative_network_icon.png",
+    "background": "#C0FF97",
+    "keywords": ["network analysis", "networks", "subject verb object tuples", "story units"]
    },
    {
     "text": "Setting Analysis",
     "doc": "widgets/settinganalysis.md",
     "icon": "../orangecontrib/storynavigation/widgets/icons/setting_analysis_icon.svg",
     "background": "#C0FF97",
     "keywords": ["clustering", "tf-idf", "word embeddings"]
-   },
-   {
-    "text": "Narrative Network",
-    "doc": "widgets/narrativenetwork.md",
-    "icon": "../orangecontrib/storynavigation/widgets/icons/narrative_network_icon.png",
-    "background": "#C0FF97",
-    "keywords": ["network analysis", "networks", "subject verb object tuples", "story units"]
    }
   ]
  ]

doc/widgets/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+<https://www.contributor-covenant.org/faq>. Translations are available at
+<https://www.contributor-covenant.org/translations>.

doc/widgets/buildingfromsource.md

@@ -0,0 +1,50 @@
+Building from source
+=======
+![](../../doc/widgets/images/storynavigator_logo_small.png)
+
+This section is for those who want to build the add-on from source and extend, customise, or fix bugs in it.
+**Note:** Mac M1 (Apple silicon) users may encounter problems with building ``storynavigator`` using certain Python 3.8.x or 3.9.x versions and / or actually building or running these specific Python versions at all on your Mac. If you encounter such issues, it is recommended to install [Rosetta 2](https://osxdaily.com/2020/12/04/how-install-rosetta-2-apple-silicon-mac/) and always run the terminal using Rosetta 2 (see how to do the latter [here](https://www.courier.com/blog/tips-and-tricks-to-setup-your-apple-m1-for-development/)) for development tasks.
+
+Requirements:
+
+1. A tool for checking out a [Git](https://git-scm.com/) repository
+2. Python 3.9.12+
+
+Steps to build and test from source:
+
+1. Get a copy of the code
+
+    ```git clone [email protected]:navigating-stories/orange-story-navigator.git```
+
+2. Change into the ```orange-story-navigator/``` directory
+
+    ```cd orange-story-navigator```
+
+3. Create and activate a new Python virtual environment using [virtualenv](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/)
+
+4. Run the following command
+
+    ```pip install -r requirements.txt```
+
+5. If Step 4. completed with no errors, run this command
+
+    ```pip install -e .```
+
+> This command installs the widget and registers it with your Orange3 installation. If you encountered an error during Step 4, file an [issue](https://github.com/navigating-stories/orange-story-navigator/issues) with the details and skip the remaining steps.
+
+6. Run ```orange-canvas``` or ```python -m Orange.canvas```
+
+The Orange3 application should shortly start up with a splash screen
+
+## Testing
+
+Run tests with `pytest`.
+
+For coverage:
+
+```python
+coverage run -m pytest
+coverage report
+# or
+coverage html
+```

doc/widgets/changelog.md

@@ -0,0 +1,8 @@
+Changelog
+=======
+
+![](../../doc/widgets/images/storynavigator_logo_small.png)
+
+"Changelog": list of featured added, removed / amended in each version
+
+Coming soon!

doc/widgets/contact.md

@@ -0,0 +1,41 @@
+Contact Information
+=======
+![](../../doc/widgets/images/storynavigator_logo_small.png)
+
+
+The Story Navigator is maintained by the [Netherlands eScience Center](https://www.esciencecenter.nl/) in collaboration with the [Faculty of Behavioural, Management and Social Sciences (BMS)](https://www.utwente.nl/en/bms/) at the [University of Twente](https://www.utwente.nl/en/). If you have any questions, feedback, or need support, please feel free to reach out to us. Below are the primary contacts and useful links for your reference:
+
+**General Inquiries**
+
+For general questions and information, you can reach the Principal Investigator Prof. dr. Gerben J. Westerhof:
+- **Email**: [[email protected]](mailto:[email protected])
+- **Phone**: +31.53.489.6074
+- **Website**: https://personen.utwente.nl/g.j.westerhof
+
+**Technical Support**
+
+For technical support and troubleshooting, please contact our Lead Research Software Engineer Kody Moodley or visit the Orange Data Mining website for additional resources:
+- **Email**: [[email protected]](mailto:[email protected])
+- **Orange**: [https://orangedatamining.com/](https://orangedatamining.com/)
+- **Documentation**: [https://orange-story-navigator.readthedocs.io/en/latest/](https://orange-story-navigator.readthedocs.io/en/latest/)
+
+**Collaboration**
+
+If you are interested in contributing, reach out at:
+- **Email**: [[email protected]](mailto:[email protected])
+- **Github**: [https://github.com/navigating-stories/orange-story-navigator](mailto:https://github.com/navigating-stories/orange-story-navigator)
+
+**Follow Us**
+
+Stay updated on the project by following us on:
+- **RSD**: [Research Software Directory](https://research-software-directory.org/projects/navigating-stories)
+- **LinkedIn**: [https://www.linkedin.com/company/netherlands-escience-center/](https://www.linkedin.com/company/netherlands-escience-center/)
+- **Homepage**: [https://navigating-stories.github.io/](https://navigating-stories.github.io/)
+- **Story Lab**: [https://www.utwente.nl/en/bms/ehealth/research/story-lab/](https://www.utwente.nl/en/bms/ehealth/research/story-lab/)
+
+
+For more detailed information, visit our [official website](https://www.esciencecenter.nl/).
+
+---
+
+Thank you for your interest and support. We look forward to assisting you!