Index » PageStream Support » Documentation » PageStream Doc readme
Sign in to add a comment Pages: 1
2002-10-01 15:56:03 CT #1
Deron Kazmaier
From: United States
Registered: 2006-01-29
Posts: 4599

PageStream4.1 Documentation Project Readme

I just did a run through the PageStream User Manual. First, I must say
everytime I look at the help system, I am amazed at the
incredible work Mario Galante did. Thanks Mario!!!

I'm trying to jot things down as I see them. I've added a few things as I
remember them. Obviously just looking at the 4.1 features
(and 4.0 in some cases) is an obvious place to start. Let me know if I
missed something!!!

I've put my thoughts down in this file as more of a good suggestion than
something cast in stone. If a feature would be better
documented in another location in the manual, or some other design issue,
just bring it up on the PageStreamDocs list!

When linking between sections, remember that this documentation will serve
both electronic and printed. So don't put in things like
"Click here", but instead "See also xxxx" or some such (as appropriate) and
link the xxxxx to the proper place.

Chapters
--------
The manual is divided in chapters. Those chapters are:
Getting Started
Lessons
Document
Text
Objects
Line, Fill & Color
Printing
Scripting
Appendices

Each chapter is then subdivided into sections. Each section tries to cover
a single major concept (is that the right term?) in that
chapter.

Sections
--------
Each section has a single HTML page devoted to it.

At the top of the section is the PGS icon and section title kept in a
single cell table with no border. That first table usually
contain the "Summary" graphical title (only present when there is a second
table with links to anchors into this section).

This is occasionally followed by a "summary" of the section at hand. This
is not in a table.

Then this is usually followed by a list of links into this section's
subsections, contained in a second single cell table with no border.

The text of the section then follows. Again, not in a table.

At the bottom of the section page is the "Browse" graphical title and
hypertext links to the previous and next section (or chapter),
links to related topics if applicable, and a link back to the table of
contents. Again, contained within a single cell table
with no border.

The reason for the borderless tables is to make it possible for an import
script to cut out those items contained in a borderless table
so that generating a printed document should be easier. On the other hand,
what used to be the printed manuals sidebar items are
now placed in a single cell table with a single pixel border. That will
(should? Smile be interpreted as a sidebar item when
recreating the PageStream printed manual.

NEW SECTIONS
------------
I've attempted to create sections where they will be needed, but if a new
section is needed (or one divided), just ask on
the PageStreamDocs list. Of course, the same goes for chapters, but I don't
see much of a need at this time for any additional
chapters, but if something would be better served by being broken out into
its own chapter just ask!

THINGS TO DO
------------
There may be other locations where these should also be documented, or at
least mentions and referenced back to the main spot.
Take a few minutes to scan the toc and see if any other places might benefit.

usingtext.html
Add reference to drawing a text column with the text tool (click
and drag)
editing.html
Finish reference to section on custom text column widths & gutters
and margins
puttingtext.html
New shot of custom text frame requester
Document custom text frames requester
tranformation.html
New shots of transformation
New examples?
Add fade to, behind/infront, page offset instructions
charactersets.html
Rewrite into English Smile Add to list of currently supported
character sets. Document format of character sets?
customizing.html
New shots to show new scrolling list of pref items
New shots for file & folder pref, and new folder items
New shot for type prefs -> characterset, and reference to
character sets appendix
pages.html
New shot for Move Page
Add info on moving pages between chapters using the Move Page
dialog box
spellchecking.html
New shot of Lookup Words
Export and Batch Add mini-menus for Edit->Lookup Words.
(documented, needs proofing)
paragraph.html
New shot of Define Hyphenation
Export and Batch Add mini-menus for Edit->Define->Hyphenation
(documented, needs proofing)
selectingtext.html
Shift-Cursor selection. Documented, but by me Smile Needs proofing.
navigating.html
New shot of Bookmarks
Document using Bookmarks (how to insert, goto)
newslabels.html
New shots of Imposition panel, Signature, Repeating, and Mail
Merge panel
Document signature printing
Document repeat printing
Document mail merge printing
*** this one might need to be broken into seperate sections. We
will have to see how big they become.
desktopprint.html
New Shot for panels
imagesetter.html
Document collect for output (actually, already document, just
check it) I guess it looks alright (I moved it
so I am a little nervous Smile
separations.html
New Shot for panels
wwwpublishing.html
New shot for Save as PDF
Document saving PDF including current limitations

I'm not sure if Tables should be blended into objects, or have its own
sections. I think blending will be the best way
but I'm open to thoughts. This will be the biggest to document, so some
brave soul will have to communicate with me
directly, but if you have been wondering how it all works, and can write a
complete paragraph, you can be the first
on the block Smile
Object:
Tables
drawing tool
editing them with reshape tool & edit palette

Text in general
references to articles & frameless text objects should include
references to table cells as well (if there are any)

Lessons 1 & 2 are missing graphics. At some point in time they got lost. If
someone has them, please email them to me at support@grasshopperllc.com.
Thanks!

FOOD FOR THOUGHT
----------------
Should Save as PDF be documented in Print or Document? Currently in print,
since it is an "output" method.

A standard way of denoting "index marks" for each section/subsection should
be created. It would be simple enough to enter these
in the bottom "browse" table or some other table at the end, but we may
need more placement precision for larger sections. Placing them
in HTML comments however would make "out of the way" but would of course
make them harder to edit for everyone.

Many of the Illustration GIFs will be too low resolution for printing. I
think that eps (with gif previews) or ilus files named the same
but with the proper extension (.eps or .ilus) would make it possible to
replace the .gif files pretty easy for printing.

Since all "generic" PageStream requesters are screenshots from the Mac, we
should stick with that for now it at all possible. For those
who don't have Macs, it will be simple enough for someone else with a Mac
to create new ones. I would propose that if folks felt we needed
to do so, we could create screenshots specific to each of the platforms
(stick them in Screenshots.Windows or Screenshots.Amiga or ... ??)
With that in mind, should platform specific screen shots that are in
Illustrations be moved to screenshots folder instead?


Deron Kazmaier - support@grasshopperllc.com
Grasshopper LLC Publishing -http://www.grasshopperllc.com
PageStream
DTP for Amiga, Macintosh, and Windows

2002-10-01 18:48:21 CT #2
William F. Maddock
From: United States
Registered: 2006-02-12
Posts: 358

On 01-Oct-02 14:56:03 support@grasshopperllc.com Grasshopper Support
wrote:

>I'm not sure if Tables should be blended into objects, or have its own
>sections. I think blending will be the best way but I'm open to
>thoughts. This will be the biggest to document, so some brave soul
>will have to communicate with me directly, but if you have been
>wondering how it all works, and can write a complete paragraph, you
>can be the first on the block Smile Object:
> Tables
> drawing tool
> editing them with reshape tool & edit palette

Being someone whose HTML experience is nearly at absolute zero, and
whose writing talents go to spiritual things far, far, far more
effectively than to manual writing and who hasn't got time to
contribute in a major way, I am posting only reluctantly. I did,
however, want to comment on the placement of the Tables documentation.

It seems to me that the tables function so differently than the rest of
the application that it should at least have it's own section, if not
chapter. It's going to be *very* involved, I would think. The Table
Editor is, as you have said yourself in the past, really a miniature
spreadsheet program. In my experience, spreadsheet programs have had
some of the largest and most involved manuals I've seen. There is a lot
to them.

--
William F. Maddock Jesus Saves http://www.icon-stl.net/~wmaddock
Team
AMIGA Written using THOR 2.6a Registered User Number 1621

http://www.icon-stl.net/~wmaddock/Help-TheWorldHasBeenInvaded.txt

Salvation is by Grace alone, through faith alone in Christ alone
Leadership without personal commitment to an unchanging standard
leads to moral corruption and erosion.

"Islam is a religion in which God requires you to send your son to
die for him. Christianity is a faith in which God sends his son to
die for you."
US Attorney General John Ashcroft
--
2 Chronicles 7:17 "As for you, if you walk before me as David your
father did, and do all I command, and observe my decrees and laws,


Sign in to add a comment Pages: 1
Index » PageStream Support » Documentation » PageStream Doc readme

Sign in to add a comment.