Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unclear help in Build Novel Project dialog #250

Closed
johnblommers opened this issue May 28, 2020 · 2 comments · Fixed by #249
Closed

Unclear help in Build Novel Project dialog #250

johnblommers opened this issue May 28, 2020 · 2 comments · Fixed by #249
Assignees
Labels
documentation Request: Changes to documentation

Comments

@johnblommers
Copy link

johnblommers commented May 28, 2020

The help reads:

Build Overrides

Novel Outline Mode: This option will build an outline version of the novel rather than the full thing. It overrides the title format settings without changing them. Each title will be written out, and the synopsis text will appear instead of the body text of the files. Some of the other options are still available in Outline Mode.

But there isn't any section entitled Build Overrides or Novel Outline Mode.

My guess is that this is intended to suggest the following preset to generate an outline with just the headings and the synopsis, a very handy thing:

  • Include synopsis ✓
  • Include comments ✗
  • Include keywords ✗
  • Include novel files ✓
  • Include note files ✗
  • Ignore export flag ✗
  • Exclude body text ✓
@vkbo
Copy link
Owner

vkbo commented May 28, 2020

That's correct. It was in there when I wrote that text, but I actually removed that option because it hard coded a bunch of settings that I myself wanted to tweak when I wanted to use it on a real project. Instead, I made the Exclude body text option so you could make your outline with whatever meta data and comments you wanted.

I'll update this too in PR #249, and at the same time add all the title formatting codes into a tool tip.

Edit: Also, I'm considering removing that help text option because I'm not sure it's a good idea to have duplicate help information here and in the docs. Maybe I should just add some good tooltips instead.

@vkbo vkbo self-assigned this May 28, 2020
@vkbo vkbo added the documentation Request: Changes to documentation label May 28, 2020
@vkbo vkbo linked a pull request May 28, 2020 that will close this issue
@vkbo
Copy link
Owner

vkbo commented May 28, 2020

I decided to remove the help button and text. It isn't consistent with how help is provided elsewhere, which is mainly through tooltips. I've instead written tooltips that explain how each field or switch is used.

@vkbo vkbo closed this as completed in #249 May 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Request: Changes to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants