TweetFollow Us on Twitter

SoftPolish
Volume Number:8
Issue Number:6
Column Tag:Jörg's Folder

Polish Your Application

SoftPolish™ - a quality checker to help put the shining touch on your application

By Jörg Langowski, MacTutor Regular Contributing Author

No, contrary to what you might think, looking at my family name and my involvement with Forth, I’m not writing about how to translate your favorite C++ program into reversed Polish notation. This time we pronounce ‘polish’ with a short ‘o’ like in ‘soft’. Language Systems, the guys who brought you LS Fortran for MPW, have just recently started to ship SoftPolish, a software quality improvement tool that helps you put the last shining touch on your - almost - ready to go application. I received an evaluation copy and want to tell you my impressions.

SoftPolish is, as I said, a tool. I just read a letter in the July issue complaining about the tools’ reviews which we have regularly (and about the needlessness of Fortran and Forth, for that matter, so I have to answer to this one). What after all do we program the Macintosh for? For our own pleasure, that’s for sure, but many of us make real money developing and selling programs, or writing programs that help them doing some other job, like treating data. Now, you can write programs for fun and be content if that great idea of a new sorting algorithm or a hack around the Launch trap or that fast 3-D plotting routine really works. But no one (or only a few good friends) will listen to your well-deserved enthusiasm or even use your program when a) you can’t explain (Xplain?) to them how to use it and b) they can’t use it without your continuing help because of illogical behavior or -worse - ‘undocumented features’ (no, NO!!! don’t double-click the mouse outside that window, you’ll destroy your hard disk!!!! oh well too late.). This is speaking of my own experience, so let’s hear it for good documentation and well-thought out and bug-free user interfaces. Not that I’m writing any of that stuff for MY programs. I did it once, for something that I distributed to a number of people, and in a very imperfect way. Still it took a lot of time, and I admire those who have the patience to create a perfectly looking, logical, easy to use interface to their original software idea and then give it away or sell it at cost. In my own field, the genetic data editing package DNA Strider comes to mind, or the desk accessory editor McSink (now Vantage, a commercial product).

Anyway, SoftPolish is a program that helps you to create a user interface that doesn’t confuse the user, or pull the rug under his feet because you forget to put some necessary resources into your application and that didn’t show up during testing.

How SoftPolish works

SoftPolish checks three major aspects of a Macintosh application:

• the consistency of the user interface;

• the validity of resources, their types and numbers;

• the spelling of strings anywhere in the program (dialogs and alerts, STR, STR# resources, file and folder names, etc.).

To see what SoftPolish does, let’s go through the example that is given with the disk. There is an application ‘Testapp’ created with AppMaker, which contains several deliberate errors.

When you start SoftPolish, it comes up with a ‘Navigator window’, like a modeless dialog box. Here, you can choose one of six functions (which are also accessible through the menus): Choose Target, Build User Dictionary, Scan Target, Correct Spelling, Clean up, and Help.

You have to choose a target first, so you click the corresponding box, you select the application to ‘polish’ from a standard file dialog, and then you may start by clicking ‘Scan Target’. The User Interface Police then starts to scan all resources of the application. The following checks can be made:

• Are the menu command key equivalents correct, i.e., are any characters used in duplicate, or used in a way not recommended by the Apple Human Interface Guidelines?

• Are the menu titles correctly capitalized? (i.e., a menu or window title starting with a lower case letter is not recommended)?

• Do the dialogs and menus fit on a small screen (PowerBook or Macintosh Classic)?

• Is the space for dialog text items large enough to contain all the text (such problems may occur after an application has been localized for a different language)?

• Do all dialog items fit inside the dialog box, are they non-overlapping, not too small or too big, and is there enough space between them and the dialog border?

• ‘Old style’ quotation marks like the ones I use all the time (',") are flagged because they should be replaced by the “new style” (“,”,‘,’). So are ellipses ( ) that are made out of three periods in a row (. . .).

• Word and sentence spacing are checked; you should not use two spaces between words, or after a period.

• Are any resource numbers used that are reserved by Apple? Are there any resource types which are lower-case only (that’s also reserved)?

• The internal consistency of resources is checked.

• Any resources which should have a fixed size (like an ICON) are flagged if their actual size is different.

• ALRTs, DLOGs and DITLs are cross-checked to make sure the resources referred to in another resource are present.

• All strings in the application (STR#, STR, DITL, file and folder names etc.) are checked for correct spelling. An English dictionary is included; I also received a French dictionary in my evaluation copy, and there are dictionaries available for other languages (Dutch, French, French Canadian, German, Italian, Norwegian, Portuguese, Spanish, Swedish, and U.K. English at $49 each). You can build your own user dictionary for technical terms not included in the main dictionary.

While the scan is running, a log is written to a text window which you can review after the scan, and save or print.

SoftPolice - sorry, SoftPolish - will also make some of the necessary changes to your application if you tell it to do so. Misspelled words can be corrected - like in any good spelling checker, alternatives are suggested - and you can define a list of unwanted resources that you want to be removed. For instance, some resources might be left over from testing and are not needed in the final application. The modification and creation dates will also be set to any value you like. Any inconsistencies found in resource numbering or dialog layout will, of course, have to be corrected by the programmer.

Documentation

The 50-page manual is of the usual quality you’d expect from Language Systems when you know their Fortran manual. The various options of the program are described very clearly, and a tutorial is provided that lets you test some of SoftPolish’s features on a test application. All the important information from the manual is also repeated in a Help window that you can call it up.

I’ll show you some examples of the types of errors flagged in the test application:

1. Multiple spaces in About box:

yields the following error message:

  DITL 1 <Item #2> “About” 

The user interface was created with AppMaker, then AppMaker generated the source code.

  •• Multiple spaces between words

The next dialog contains several errors:

DITL 130 <Item #1> “Mistake” 
    cancel
  •• Should the word start with a capital letter?

  DITL 130 <Item #2> “Mistake” 
    This Check box will not fit in this dialog
  •• Space is not wide enough for the text

  DITL 130 <Item #3> “Mistake” 
    This  Item   is  Spaced.   Out
  •• Multiple spaces between words

  DITL 130 <Item #4> “Mistake” 
    This item is Mspelled
  •• Questionable spelling: Mspelled

  DLOG 130 “Mistake” 
  •• DITL 130 item 2 is within 6 pixels of the edge of the window
  •• DITL 130 item 3 is within 6 pixels of the edge of the window
  •• DITL 130 item 4 is within 6 pixels of the edge of the window

The last dialog box will definitely create a problem for a Mac Plus or Classic user and SoftPolish complains at once:

  DLOG 129 “Problems” 
  •• The window is too wide to fit on 9” screens

  DITL 129 <Item #3> “Problems” 

This is a poorly desined dialog box. It definitely will not fit on a small screen!

  •• Questionable spelling: desined

  DITL 129 <Item #9> “Problems” 
    TestApp’s comment
  •• Should this be a real apostrophe (’)?

  DITL 129 “Problems” 
  •• PICT 128 needed by DITL 129 item 4 is missing!

There are many more errors which are flagged in this program by SoftPolish. Actually, it becomes annoying to see all of them and you really feel you have the User Interface Squad on your back. But I think it is of great help to developers in the final steps of creating a new program, it should remove many errors which may otherwise be detected only after months of testing (i.e., alert boxes which are presented only for very rare errors).

Aside from the spelling checker, an absolute necessity looking at some of the existing applications, I especially like the option which cross-checks whether all resources referenced in a dialog are actually present, and the size checks on dialog boxes and dialog items. The only negative thing about SoftPolish may be its rather steep price - $295 suggested - but mail order sources might offer it cheaper. [Check the MacTutor Mail Order Store for a special of $169 until October 31, 1992. - Ed.]. An individual developer will probably think twice before spending 300 bucks for a tool which is used much less often than for instance his C compiler which is in the same price range.

User customization

When I just wanted to send off my column, I received two tech notes from Language Systems (which they actually had announced to me before). They describe how you can modify the resource checking process to adapt it to your own specifications (i.e., play legislator to the User Police).

First, there are two resources that you can modify which specify all the minimum and maximum sizes of buttons, check boxes, how far away from the border a dialog item has to be, the dimensions of small screens, etc., etc. You can change all these numbers, of course.

The most important feature, however, is that you can add your own resource-checking code for resource types that are not checked by SoftPolish by default. Plug-in code modules, state of the art of today’s software technology (by the way, I’m anxious to see the dynamically linked libraries announced by Apple).

An excerpt from the tech note explains best how the user module mechanism works:

“When added to SoftPolish, stand-alone code modules can provide extra functionality for testing custom resources. Each code module must have a resource of type ‘SPCM’. The name of the ‘SPCM’ resource indicates what resource type the code module accepts. For example, an ‘SPCM’ resource named “DITL” is, to SoftPolish, a code module that handles ‘DITL’ resources. If you add a code module for a type SoftPolish already tests, your code module replaces the internal SoftPolish handling of that resource type.

Code modules are called by the SoftPolish application which passes the address of a parameter block. This block contains information the code module must know about the resource. It also contains mechanisms, or “callbacks”, that call service routines within SoftPolish. Language Systems supplies header files that define the parameter block in C, Pascal, and FORTRAN.

The parameter block is divided into three general areas: the header, callback information, and SoftPolish info. The header contains the handle to the resource to be tested and other useful reference information. Callback information consists of the fields a code module uses to request SoftPolish services. In normal use, code modules should change only the fields in this section. The last area, SoftPolish information, consists of the fields SoftPolish uses to pass information to the code module.

The general programming style for code modules is to first check which tests are currently requested and then make the callbacks to perform these tests.”

Pretty clever - a good example of how an extensible application should be written. For that matter, it is regrettable that not all applications have some extension mechanism built in.

Fortran news - Absoft

Unfortunately we have a delay between writing an article and its publication. It is quite short, 6-8 weeks, but sufficient that the activities of dynamic enterprises like the developers of Fortran for the Macintosh can make our reviews outdated when they appear. I just received a copy of an E-mail that Absoft sent to my colleague, Alan Hewat:

Tuesday, July 28, 1992

Dr. Hewat:

1: Unfortunately, I cannot help you (today) with AppleEvents. We don't have any examples ready for release yet. However, the next release of the compiler will include full AppleEvents capability and include much example code. We haven’t set a release date yet.

2: You are correct that Absoft does not accept Internet mail through AppleLink. Cost was not really a factor in the decision; there are easier and more direct ways to reach us. AppleLink users can send mail to “absoft”; Internet users can contact me directly: “ldr@absoft.com”.

We haven’t been using the Internet address for Mac tech support until recently; that’s why it has not been widely publicized. Eventually we will probably replace my individual address with a more generic “tech support” address.

3: Please express my appreciation to your colleague J. Langowski for pointing out some shortcomings in our documentation. A review of LS FORTRAN 3.0b (which he wrote some time ago, but which was only recently published here) incorrectly claimed that Absoft MacFortran II could not pass the Paranoia accuracy test.

But he cannot be held accountable for the error. After reading his remarks, we concluded our manual and example code do not adequately discuss the issue of FPU math versus strict IEEE compliance. We’ve always been able to pass Paranoia, going back to MacFortran/MPW 1.0; as long as you set the rounding precision of the FPU appropriately. But we’re going to start documenting more clearly how to do this and under what conditions it would be necessary.

If you or your colleague have any questions on this or other technical matters, please feel free to contact me.

Lee David Rimar

Absoft Technical Support

ldr@absoft.com

Thank you very much for these remarks. I thought with the last article that I wrote the question of accuracy vs. speed in Absoft Fortran was resolved (i.e., when you give up the speed advantage over LS Fortran, you gain back the accuracy); but I might still be wrong if there are some other non-documented options to set the rounding precision of the FPU. I look forward to seeing some newer examples by Absoft, and especially the new AppleEvents-aware compiler. You’ll hear about it.

 
AAPL
$100.96
Apple Inc.
-0.83
MSFT
$47.52
Microsoft Corpora
+0.84
GOOG
$596.08
Google Inc.
+6.81

MacTech Search:
Community Search:

Software Updates via MacUpdate

Audio Hijack Pro 2.11.3 - Record and enh...
Audio Hijack Pro drastically changes the way you use audio on your computer, giving you the freedom to listen to audio when you want and how you want. Record and enhance any audio with Audio Hijack... Read more
Airfoil 4.8.9 - Send audio from any app...
Airfoil allows you to send any audio to AirPort Express units, Apple TVs, and even other Macs and PCs, all in sync! It's your audio - everywhere. With Airfoil you can take audio from any... Read more
WhatRoute 1.13.0 - Geographically trace...
WhatRoute is designed to find the names of all the routers an IP packet passes through on its way from your Mac to a destination host. It also measures the round-trip time from your Mac to the... Read more
Chromium 37.0.2062.122 - Fast and stable...
Chromium is an open-source browser project that aims to build a safer, faster, and more stable way for all Internet users to experience the web. FreeSMUG-Free OpenSource Mac User Group build is... Read more
Attachment Tamer 3.1.14b9 - Take control...
Attachment Tamer gives you control over attachment handling in Apple Mail. It fixes the most annoying Apple Mail flaws, ensures compatibility with other email software, and allows you to set up how... Read more
Duplicate Annihilator 5.0 - Find and del...
Duplicate Annihilator takes on the time-consuming task of comparing the images in your iPhoto library using effective algorithms to make sure that no duplicate escapes. Duplicate Annihilator detects... Read more
jAlbum Pro 12.2 - Organize your digital...
jAlbum Pro has all the features you love in jAlbum, but comes with a commercial license. With jAlbum, you can create gorgeous custom photo galleries for the Web without writing a line of code!... Read more
jAlbum 12.2 - Create custom photo galler...
With jAlbum, you can create gorgeous custom photo galleries for the Web without writing a line of code! Beginner-friendly, with pro results Simply drag and drop photos into groups, choose a design... Read more
Quicken 2015 2.0.4 - Complete personal f...
Quicken 2015 helps you manage all your personal finances in one place, so you can see where you're spending and where you can save. Quicken automatically categorizes your financial transactions,... Read more
iMazing 1.0 - Complete iOS device manage...
iMazing (formerly DiskAid) is the ultimate iOS device manager with capabilities far beyond what iTunes offers. With iMazing and your iOS device (iPhone, iPad, or iPod), you can: Copy music to and... Read more

Latest Forum Discussions

See All

View Source – HTML, JavaScript and CSS...
View Source – HTML, JavaScript and CSS 1.0 Device: iOS Universal Category: Utilities Price: $.99, Version: 1.0 (iTunes) Description: View Source is an app plus an iOS 8 Safari extension that makes it easy to do one key web developer... | Read more »
Avenged Sevenfold’s Hail To The King: De...
Avenged Sevenfold’s Hail To The King: Deathbat is Coming to iOS on October 16th Posted by Jessica Fisher on September 19th, 2014 [ permalink ] Just in time for Halloween, on October 16 Avenged Sevenfold will be launching | Read more »
Talisman Has Gone Universal – Can Now be...
Talisman Has Gone Universal – Can Now be Played on the iPhone Posted by Jessica Fisher on September 19th, 2014 [ permalink ] | Read more »
Tap Army Review
Tap Army Review By Jennifer Allen on September 19th, 2014 Our Rating: :: SHOOT EM ALLUniversal App - Designed for iPhone and iPad Mindless but fun, Tap Army is a lane-based shooter that should help you relieve some stress.   | Read more »
Monsters! Volcanoes! Loot! Epic Island f...
Monsters! Volcanoes! Loot! | Read more »
Plunder Pirates: Tips, Tricks, Strategie...
Ahoy There, Seadogs: Interested in knowing our thoughts on all this plundering and pirating? Check out our Plunder Pirates Review! Have you just downloaded the rather enjoyable pirate-em-up Plunder Pirates and are in need of some assistance? Never... | Read more »
Goat Simulator Review
Goat Simulator Review By Lee Hamlet on September 19th, 2014 Our Rating: :: THE GRUFFEST OF BILLY GOATSUniversal App - Designed for iPhone and iPad Unleash chaos as a grumpy goat in this humorous but short-lived casual game.   | Read more »
A New and Improved Wunderlist is Here fo...
A New and Improved Wunderlist is Here for iOS 8 Posted by Jessica Fisher on September 19th, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Evernote Update for iOS 8 Adds Web Clipp...
Evernote Update for iOS 8 Adds Web Clipping, Quick Notes, and More Posted by Ellis Spice on September 19th, 2014 [ permalink ] | Read more »
Apple Names Ultimate Productivity Bundl...
Apple Names Ultimate Productivity Bundle by Readdle as the Essential Bundle on the App Store Posted by Jessica Fisher on September 19th, 2014 [ permalink | Read more »

Price Scanner via MacPrices.net

iFixIt Tears Down iPhone 6; Awards Respectabl...
iFixit notes that even the smaller 4.7″ iPhone 6 is a giant among iPhones; so big that Apple couldn’t fit it into the familiar iPhone form factor. In a welcome reversal of a recent trend to more or... Read more
Phone 6 Guide – Tips Book For Both iPhone 6...
iOS Guides has announced its latest eBook: iPhone 6 Guide. Brought to you by the expert team at iOS Guides, and written by best-selling technology author Tom Rudderham, iPhone 6 Guide is packed with... Read more
How to Upgrade iPhone iPad to iOS 8 without D...
PhoneClean, a iPhone cleaner utility offered by iMobie Inc., reveals a solution for upgrading iPhone and iPad to iOS 8 without deleting photos, apps, the new U2 album or anything. Thanks to more than... Read more
Inpaint 6 – Photo Retouching Tool Gets Faster...
TeoreX has announced Inpaint 6, a simple retouching tool for end users that helps remove scratches, watermarks, and timestamps as well as more complex objects like strangers, unwanted elements and... Read more
Worldwide PC Monitor Market Sees Growth in To...
Worldwide PC monitor shipments totaled 32.5 million units in the second quarter of 2014 (2Q14), a year-over-year decline of -2.9%, according to the International Data Corporation (IDC) Worldwide... Read more
Updated Price Trackers
We’ve updated our Mac Price Trackers with the latest information on prices, bundles, and availability on systems from Apple’s authorized internet/catalog resellers: - 15″ MacBook Pros - 13″ MacBook... Read more
Mac Pros available for up to $260 off MSRP
Adorama has Mac Pros on sale for up to $260 off MSRP. Shipping is free, and Adorama charges sales tax in NY & NJ only: - 4-core Mac Pro: $2839.99, $160 off MSRP - 6-core Mac Pro: $3739.99, $260... Read more
13-inch 2.6GHz/256GB Retina MacBook Pros avai...
B&H Photo has the 13″ 2.6GHz/256GB Retina MacBook Pro on sale for $1379 including free shipping plus NY sales tax only. Their price is $120 off MSRP. Read more
Previous-generation 15-inch 2.0GHz Retina Mac...
B&H Photo has leftover previous-generation 15″ 2.0GHz Retina MacBook Pros now available for $1599 including free shipping plus NY sales tax only. Their price is $400 off original MSRP. B&H... Read more
21″ 2.7GHz iMac available for $1179, save $12...
Adorama has 21″ 2.7GHz Hawell iMacs on sale for $1179.99 including free shipping. Their price is $120 off MSRP. NY and NJ sales tax only. Read more

Jobs Board

*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
Position Opening at *Apple* - Apple (United...
**Job Summary** At the Apple Store, you connect business professionals and entrepreneurs with the tools they need in order to put Apple solutions to work in their Read more
Position Opening at *Apple* - Apple (United...
**Job Summary** The Apple Store is a retail environment like no other - uniquely focused on delivering amazing customer experiences. As an Expert, you introduce people Read more
Position Opening at *Apple* - Apple (United...
**Job Summary** As businesses discover the power of Apple computers and mobile devices, it's your job - as a Solutions Engineer - to show them how to introduce these Read more
Position Opening at *Apple* - Apple (United...
…Summary** As a Specialist, you help create the energy and excitement around Apple products, providing the right solutions and getting products into customers' hands. You Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.