Servoy 2.1 Documentation is available

Servoy announcements

Servoy 2.1 Documentation is available

Postby mnorman » Sun Sep 12, 2004 8:05 pm

The Servoy 2.1 documentation is now available.

In addition to including all of the new functionality in Servoy 2.1, the
Servoy documentation has been expanded by over 250 pages; over 600
screenshots and examples have been updated; all Servoy functions and
runtime properties have been indexed; new chapters have been added on
i18n and Servoy CSS styles; and much more.

Servoy provides documentation in three formats:

Servoy Books
Servoy Downloadable PDF Files
Servoy Online Help

Servoy 2.1 Books
______________

These Servoy 2.1 books can be purchased from the online Servoy Store:

Servoy Developer Edition Volume 1: User's Guide [ info ]
Servoy Developer Edition Volume 2: Reference Guide [ info ]
Servoy Client Edition User's Guide [ info ]
Servoy Application Server Administrator's Guide [ info ]
Servoy Advanced Programming Guide for FileMaker Developers [ info ]

For more detail about a Servoy book in the Servoy Store:

1. Click the Servoy Store link.
2. Scroll down to the "Books" section in the Servoy Store.
3. You will see an information button [ i ] located to the left of each Servoy Book title.
4. Click the information button [ i ] for the Servoy Book you are interested in.

If you find the Servoy documentation helpful in developing your solutions,
please consider purchasing one or more of the Servoy Books. Your
purchases help to pay for the cost of providing and constantly improving
Servoy's documentation (now more than 1800 pages with screenshots
and examples), as well as being able to currently offer all of the Servoy
documentation in pdf format for you to download free of charge.


Servoy 2.1 PDF Files
_________________

The Servoy 2.1 documentation pdf files are available for download.
Choose the online Servoy Developers/Documentation link to view the
list of available pdf files.


Servoy 2.1 Online Help
__________________

Servoy 2.1 Online Help has been available since the release of Servoy 2.1.

Servoy 2.1 Client Edition Help is included as part of the Servoy
installation and is made available when deploying to Servoy Clients.
Choose Help > Help to open the Servoy Client Help Navigator.

Servoy Application Server 2.1 documentation is included as a pdf file
when Servoy is installed. The Servoy Server pdf file is located in the
Servoy/docs folder/directory.

The Servoy Developer 2.1 online help combines the information from
Servoy Developer Edition Volume 1: User's Guide and Volume 2:
Reference Guide into one file.

To open the Servoy Help Navigator:

1. Make sure that Designer is the active window in Servoy Developer .
2. Choose Help > Help (F1).

NOTE: If you have just performed a full install of Servoy 2.1, then Servoy
Developer Help will not be included in the installation. To install Servoy
Developer 2.1 Help, Choose Help > Help (F1). In the install dialog that
appears, press "Download". Be patient since the Help download is fairly
large (23MB). Once the Help download is complete, you will be able to
access the Servoy Help Navigator by choosing Help (F1) from the Help menu.

To find out more about the Servoy Help Navigator features:

1. Choose Help > Help (F1).
2. Click once to open the "Contents" tab of the Help Navigator.
3. Scroll to the bottom of the "Contents" tab.
4. Double click on "Appendix".
5. Double click on "The Servoy Help Navigator" section.


Searching for a Servoy 2.1 function or run time property in the Help Navigator
______________________________________________________________

As of Servoy 2.1, all Servoy functions and run time properties have been
added as separate index entries - and as a result, can be searched for by
the name of the function or property.

To find the topic that contains a Servoy function or run time property:

1. Choose Help > Help to open the Servoy Help Navigator.
2. Click once to open the "Index" tab.
3. Type one or more letters of the function you are searching for.
4. Select the desired function or run time property from the Index entry list.
5. Double click on the appropriate topic from the Topic list at the bottom of the "Index" tab.

To find the instance(s) of the function or run time property within a topic:

1. Make sure that the desired topic is already open.
(Follow the steps listed above to search for a topic.)

2. Choose Tools > Find (CTRL-F/CMD-F)
3. Type in the criteria you wish to search for in "Find What".
4. Press the "Find Next" button.
5. The first instance of your search criteria will be highlighted.
6. Repeat step 4 for each additional instance of the search criteria.

NOTE: The steps shown above are available in the Servoy Developer
Edition User's Guide, p. 693; in the Servoy Developer Edition User's Guide
pdf file; and is also included in The Servoy Help Navigator section of the
Appendix - search for "Servoy Help Find Dialog".
mnorman
 
Posts: 106
Joined: Wed Sep 24, 2003 8:50 pm
Location: Alturas, CA

Postby dbonnett » Sun Sep 12, 2004 10:57 pm

Marc,
Thanks for the updated docs so quickly after the release of 2.1.
One request for the pdfs: Could you please add bookmarks to the TOC and index so that we can jump to the appropriate page from there? It is a real pain to scroll through the files looking for something 600 pages in (or back from the index).

Thanks!
-dave bonnett
dbonnett
 
Posts: 31
Joined: Fri May 14, 2004 10:59 pm
Location: Boulder, CO

Postby willieseabrook » Mon Sep 13, 2004 4:09 am

dbonnett wrote:Marc,
Thanks for the updated docs so quickly after the release of 2.1.
One request for the pdfs: Could you please add bookmarks to the TOC and index so that we can jump to the appropriate page from there? It is a real pain to scroll through the files looking for something 600 pages in (or back from the index).

Thanks!
-dave bonnett


Yeah, that would be a *huge* improvement.
willieseabrook
 
Posts: 27
Joined: Wed Jul 28, 2004 10:26 am

Postby mnorman » Mon Sep 13, 2004 5:01 am

dbonnett wrote:Marc,
Thanks for the updated docs so quickly after the release of 2.1.
One request for the pdfs: Could you please add bookmarks to the TOC and index so that we can jump to the appropriate page from there? It is a real pain to scroll through the files looking for something 600 pages in (or back from the index).

Thanks!
-dave bonnett


We will look at the possibility of adding bookmarks to the Table of
Contents and Index.

In the meantime, using Acrobat Reader (6) for example,

To search for one or more characters:
_______________________________

- Open the pdf document you wish to search.
- Choose Edit > Search (CTRL-F/CMD-F).
- Enter the criteria you wish to search for in the Search PDF panel.
- Check or uncheck any other search filter options.
- Press the "Search" button.
- You should see a list of Search Results appear in the lower half of the Search PDF Panel.
- Click once to select the desired Search Result item OR
- Choose Edit > Search Results > Next Result/Previous Result.

TIP: If you hover your mouse cursor over a Search Result item, you will
see a tooltip showing you the page number as well.


To go to a specified page number
____________________________

- Open the desired pdf document.
- Choose View > Go to > Page... (SHIFT+CTRL-N).
- Enter the page number you wish to go to in the "Go To Page" dialog.
- Press "OK" to go to the desired page.


You also have two other options:

- Buy the book. :D
- Use the online search features of the Servoy Help Navigator as
explained in the first message of this announcement post.

_______________
Marc Norman
Servoy
mnorman
 
Posts: 106
Joined: Wed Sep 24, 2003 8:50 pm
Location: Alturas, CA

Postby dbonnett » Mon Sep 13, 2004 5:31 pm

mnorman wrote:
We will look at the possibility of adding bookmarks to the Table of
Contents and Index.

Thanks!; I have seen a bunch of other online docs with this config and it makes the docs so much easier to use.
mnorman wrote:In the meantime, using Acrobat Reader (6) for example,
.
.
.
To go to a specified page number
____________________________

- Open the desired pdf document.
- Choose View > Go to > Page... (SHIFT+CTRL-N).
- Enter the page number you wish to go to in the "Go To Page" dialog.
- Press "OK" to go to the desired page.

I use the find in Acrobat 6, which is nicer than the old Find, but the Go to Page is problematic since the page numbers in the TOC and Index do not correspond to the page numbers according to Acrobat; they are off by 4-6, depending on document.

mnorman wrote:You also have two other options:

- Buy the book. :D
- Use the online search features of the Servoy Help Navigator as
explained in the first message of this announcement post.

I would happily buy the docs, but I would then have to add a trailer to the bike I ride to several of my clients to transport them :shock: (also, I like to work on the back porch and I don't wanna have to carry them around..
The Help Navigator is good, but the docs are the next level of detail for me and I want the PDF layout, not the Help Navigator (better use of screen layout for text intensive content).

Lastly, a suggestion that came to mind while reading (for the 1000th time) the reminder to go to Designer mode (or make sure you are already in), to ensure that you are on the correct form, etc...; would it be possible to use icons, such as the Designer toolbar button, to indicate that this is only possible in that mode? If nothing else, it would save about 20 pages in the Dev User guide :lol:

Thanks again,
-db-
dbonnett
 
Posts: 31
Joined: Fri May 14, 2004 10:59 pm
Location: Boulder, CO

2.1 Addendum

Postby rafig » Fri Sep 24, 2004 12:43 pm

Hi,
would it be possible to just have one more PDF that lists all the information about the new features etc. in 2.1 as I have printed out the 2.0 PDFs and don't want to have to do the same for the 2.1 files and then try to work out where the new bits are?
I'm there are a lot of other developers that would appreciate a concise list too.
Thanks,
Rafi.
rafig
 
Posts: 611
Joined: Mon Dec 22, 2003 12:58 pm
Location: Watford, UK

Re: 2.1 Addendum

Postby mnorman » Fri Sep 24, 2004 2:02 pm

rafig wrote:Hi,
would it be possible to just have one more PDF that lists all the information about the new features etc. in 2.1 as I have printed out the 2.0 PDFs and don't want to have to do the same for the 2.1 files and then try to work out where the new bits are?
I'm there are a lot of other developers that would appreciate a concise list too.
Thanks,
Rafi.


Rafi,

If you are referring to the changes and enhancements in Servoy 2.1, you
can read the list at http://forum.servoy.com/viewtopic.php?t=2753

The new Servoy 2.1 documentation includes all of these changes and
enhancements.

If you are referring to ALL of the changes and expanded sections made in
the new Servoy 2.1 documentation, we have added over 250 pages in
total. The amount of changes, modifications and expansions number over
100. As such, it is impractical for us to list every change in each Servoy
2.1 book or pdf file.

That is the reason for highlighting the most major areas of enhancements
in the Servoy 2.1 documentation announcement.

_______________
Marc Norman
Servoy
mnorman
 
Posts: 106
Joined: Wed Sep 24, 2003 8:50 pm
Location: Alturas, CA

Postby rafig » Fri Sep 24, 2004 4:12 pm

as such, it is impractical for us to list every change in each Servoy
2.1 book or pdf file.

That is the reason for highlighting the most major areas of enhancements
in the Servoy 2.1 documentation announcement.


I understand what you are saying, but in the new docs., for example the Servoy Developer's User Guide, there is only one reference that mentions it is a new thing in 2.1 (page 268). If the points in the docs. that referred to the new features or changes had a 'New/Changed in 2.1', I could then search in my PDF reader for those items.
The online announcement just gives a one liner that says something is either new, fixed or enhanced, but doesn't go into details, so that isn't much help.

Rafi.
rafig
 
Posts: 611
Joined: Mon Dec 22, 2003 12:58 pm
Location: Watford, UK


Return to Announcements

Who is online

Users browsing this forum: No registered users and 2 guests