User Manual Notes

I did this using Scrivener and I am still learning about formatting the compiled version. Please forgive the odd nature of the post…My comments are in bold… everything else is from the manual.

I am using version 022 of Scrivener
I am using Revision: beta 022 - Rev. 01 BETA PREVIEW of the manual
I understand that everything I mention will not create action, but I felt it was better
to err on the side of too picky and let you ignore it.
Nice job on the manual, by the way.

4.0.1 Toolbar
To adjust the icons available, or their appearance, use the
ViewToolbar menu item, or right-click anywhere in the toolbar background area.
This feature does not exist.

4.0.5 The Inspector
It might be useful to have a description of the Inspector being the vertical section
on the right side of the screen

5.2 The Main Window
The project will be created,
and you’ll be presented with a fresh Scrivener project window
(Figure 5.2).
The left sidebar panel is your Project binder, where everything stored or created in
your project will be represented in an outline structure.
On the right side of the window
we have the editor (which is more than just a text editor, as we will shortly see).
My window shows the Inspector as well.
I don’t know if this is a setting I have changed or a change you have implemented

Figure 5.3: Progress so far
It might be better to move this illustration a little further down in the text. When
I encountered it, I started looking for what I had missed to get Chapter One to display on
my binder. I found it a few paragraphs ahead.

7.1 How the Binder is Organised
by default it is coloured a pale blue when the project window is
I don’t notice the binder window being blue.

Figure 7.1: The three default ’root’ folders
This image does not appear

8.1.1 Navigation specifics
Both Outliner and Corkboard views have an Auto-Load feature, which when
will load any selected item(s) in the other split, if one is opened. The Auto-Load
is located in the footer bar, and will appear blue when switched on.
I had a hard time catching on to the meaning of this paragraph. Finally, I realized
that Outliner was not Binder and things fell into place. I don’t know if this needs
attention (just because I was being dense) but I thought I would pass it on.

8.2 Controlling Binder Integration
Binder Affects. . . The ViewBinder Affects
If Binder Affects
First Editor has been enabled, however, all clicks will be sent to the left WIN: or
top split no matter which is active.
WIN: looks out of place. Did you mean for it to be left or top split?

9.1.1 Setting Up Label & Status
The next two forms of meta-data are flexible in what you can refer to them as.
Using the
ProjectMeta-Data Settings… ( – ,) you can set up custom names for both the label
The symbols after Meta-Data Settings look like Mac keystrokes to me. Perhaps
these got missed?

To add or remove
project labels, use the ProjectMeta-Data Settings menu item.
In the windows version, it is Project | Labels and status settings

Thanks very much for this list, sorry for only now getting back to you as for some reason it slipped off of my page of new posts.

Toolbar: It does exist, but this section was incorrect. The location of edit toolbars is Edit/Edit Toolbars. This section had some other problems as well; they’ve all been fixed.

Inspector: Good point; this is elaborated elsewhere, but given that this is the first peek into how everything fits together, that should be mentioned here. It also states that by default the Inspector may not be visible.

I see you’ve commented on that as well. I’m not sure which direction this will go. It’s off by default on the Mac, so that is probably what we’ll do with Windows as well, but I’ve added a note to verify that before launch.

Screenshots: Placement issues are something handled automatically. I can give a vague directive, but the typesetting engine I’m using makes the final decision based on the flow of text around the image, choosing the optimum placement with minimal wasted space. This doesn’t always choose the most logical place, though. While I agree that it would be nice to go through every single time and make sure everything is placed as well as possible, that’s probably more work than is feasible for each revision. This sort of care will definitely be taken with the print versions, however. I could crank up the global directive weighting to a higher value, but that might produce odd blank areas and weird wrapping if applied universally.

Also on screenshots: just ignore most of them for now. They are going to be completely redone once the interface is finalised, and there are also many missing screenshots (not just the placeholder boxes).

Binder blueness: One of the aforementioned interface polishes. The manual will be correct on this point, but is not yet as you note.

8.1.1 Navigation: Agreed, this section needs help. It’s a casualty of excessive editing. In the Mac version of the manual there are a number of other things listed here which aren’t in the Windows version yet. The paragraph you see was originally a single bullet in a list of features. They were removed but the original word flow was not looked at carefully for clarity and what is left just kind of sticks out on its own. Fortunately the missing features will probably be added before launch, so I’ve just added a note to fix up this section before release.

You do raise another point though, and that is something I’ll be spending more time on when I can: making sure the overall flow of information cascades elegantly in a linear fashion. I think the worst section for this is Part II right now. Concepts are spoken of in passing (like Outliner vs Binder) before they are exhaustively covered—especially if you skip the Quick Tour, which is entirely reasonable if someone has already done the Tutorial.

8.2 Binder Integration: This section will be cleaned up as the menu names for this will be changed to refer to the actual split orientations, rather than the generic terms currently employed. But in answer to your question, both manuals are coming out of the same source text. To fix disparities between versions I often use annotations with a MAC: or WIN: prefix. During the compile process the opposing platform-specific comments are removed from the text. In this case, I just didn’t format the annotation correctly.

9.1.1 Mac symbols: Got it. That would be more of those comment fork spots. :slight_smile:. I’m not sure what the deal is with the menu name being different here, but I’ve got a note on it in case this doesn’t change in the application.

Thanks again!