TweetFollow Us on Twitter

Oct 97 MacTech Online

Volume Number: 13 (1997)
Issue Number: 10
Column Tag: MacTech Online

MacTech Online

by Nicholas C. "nick.c" DeMello <online@mactech.com>

Building a Better ReadMe

You just finished your latest program and realized that the average user will never discover three of the new features on their own (or at least not appreciate the advantage of those features without a little explanation). That same user will find out that your program is incompatible with seven shareware system extensions that you couldn't accommodate, and that user will send you e-mail about each one -- separately. It's time to create your release notes (creatively titled "ReadMe"). This column lists a few online resources to make building your ReadMe just a little easier.

Keep it Simple

Most release notes are distributed as documents of the type "ttro" and creator "ttxt" -- SimpleText read-only documents. Originally, TeachText, SimpleText is that small text editor that gets added to your hard disk with every Apple software installation. Various groups at Apple enhanced TeachText to make it a better vehicle for their particular technologies. In 1995, a half dozen of these "enhanced" versions of TeachText were combined to form SimpleText, which can now create styled text, display colored text, play QuickTime movies, drag and drop text editing, convert text to speech, record sounds, play sounds, and has limited support for QuickDraw 3D.

Notice I said "display colored text" -- not create it. The easiest way to add colored text to your ReadMe files is with Alessandro Levi Montalcini's SimpleText Color Menu utility. This utility can modify a copy of SimpleText by installing two new menus. Features in the new menus allow you to colorize text, search, search and replace, store a default text style, and gives you the option of opening read only documents as editable text.

Pictures can be added to your SimpleText documents with a resource editor. Open the document with ResEdit or Resorcerer and save your pictures as 'pict' resources (number them 1000 and up) into the resource fork. Then, open the document with SimpleText and enter a non-breaking space (option-spacebar, the ASCII character $CA) where you want each picture to appear. SimpleText will draw 'pict' ID 1000 horizontally centered on the screen. The top of the picture will begin where the first non-breaking space appears. SimpleText will display 'pict' ID 1001 at the second non-breaking space and so on. Because SimpleText is a text editor, it will only allocate enough space on the screen for the non-breaking space character (not the picture), you will have to add sufficient white space to make sure the picture doesn't overlap text. Apple's Technote 1005 (by Bryan Stearns, revised by Mark Cookson), "The Complete Guide to SimpleText," provides a detailed description of fine art of importing 'pict' resources into SimpleText documents.

Download PICTify by Scott A. Johnson to help you collect those 'pict' resources. PICTify is a system extension which allows you to grab screen shots (cropped as you take them or of the whole screen). In addition to being able to take screen shots with menus down, PICTify has a feature to allow you to grab only the contents of the foremost window--ideal for taking quick pictures of dialog boxes. Best of all, PICTify allows you to save your images as either pict files or 'pict' resources.

SimpleText is not able to save documents as 'ttro'--but that is how Apple recommends you distribute your release notes. There are a number of utilities for changing file types, but I'm particularly fond of a freeware utility called "TEXT <-> ttro." It toggles files dropped on it between "TEXT" and "ttro" types, and causes the finder to immediatley update the icon (something many type utilities fail to do).

SimpleText
ftp://swupdates.info.apple.com/Apple.Support.Area/Apple.Software.Updates/US/Macintosh/Utilities/SimpleText_1.3.sea.hqx
Alessandro Levi Montalcini, author of SimpleText Color Menu
http://persoweb.francenet.fr/~alm/
Technote 1005: The Complete Guide to SimpleText
http://gemma.apple.com/dev/technotes/tn/tn1005.html
Scott A. Johnson's PICTify
ftp://mirrors.aol.com/pub/info-mac/gst/grf/pictify-15.hqx
TEXT <-> ttro by Laurence Harris
ftp://mirrors.aol.com/pub/info-mac/text/text-to-ttro.hqx

Beyond SimpleText

SimpleText isn't your only choice for creating distribution documents. Mark Wall's feature rich DOCMaker is the standard for creating stand-alone, self-running document files. DOCMaker allows you to add hypertext, pop-up graphics, startup-splash screens with sound, and even lets you import RTF files. It's overkill for a ReadMe, but when you find it's time to start including a manual with your application, this is the right tool.

Marco Piovanelli is the author of the WASTE (WorldScript-aware Styled Text Engine) library. This powerful text editing engine has been incorporated into many text editors, and appropriately enough into Marco's own answer to SimpleText. Piovanelli's scriptable Style editor lets you paste graphics from your clipboard within styled and colored text, then save those documents as stand-alone self-running documents, as read-only SimpleText, RTF, or your choice of over a dozen word processing formats.

DocMaker 4.8 by Mark Wall of Green Mountain Software
http://www.hsv.tis.net/~greenmtn/
Marco Piovanelli's Style (also the WASTE -- WorldScript-aware Styled Text Engine -- Library)
http://www.kagi.com/authors/piovanel/

These and other links are available at the MacTech URL database www.mactech.com/magazine/urls/.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Apple GarageBand 10.1 - Complete recordi...
The new GarageBand is a whole music creation studio right inside your Mac -- complete with keyboard, synths, orchestral and percussion instruments, presets for guitar and voice, an entirely... Read more
Duplicate Annihilator 5.7.7 - Find and d...
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... Read more
OS X Server 4.1.3 - For OS X 10.10 Yosem...
Designed for OS X and iOS devices, OS X Server makes it easy to share files, schedule meetings, synchronize contacts, develop software, host your own website, publish wikis, configure Mac, iPhone,... Read more
pwSafe 4.1 - Secure password management...
pwSafe provides simple and secure password management across devices and computers. pwSafe uses iCloud to keep your password databases backed-up and synced between Macs and iOS devices. It is... Read more
Kodi 15.0.rc1 - Powerful media center to...
Kodi (was XBMC) is an award-winning free and open-source (GPL) software media player and entertainment hub that can be installed on Linux, OS X, Windows, iOS, and Android, featuring a 10-foot user... Read more
Coda 2.5.11 - One-window Web development...
Coda is a powerful Web editor that puts everything in one place. An editor. Terminal. CSS. Files. With Coda 2, we went beyond expectations. With loads of new, much-requested features, a few surprises... Read more
Bookends 12.5.7 - Reference management a...
Bookends is a full-featured bibliography/reference and information-management system for students and professionals. Access the power of Bookends directly from Mellel, Nisus Writer Pro, or MS Word (... Read more
Maya 2016 - Professional 3D modeling and...
Maya is an award-winning software and powerful, integrated 3D modeling, animation, visual effects, and rendering solution. Because Maya is based on an open architecture, all your work can be scripted... Read more
RapidWeaver 6.2.3 - Create template-base...
RapidWeaver is a next-generation Web design application to help you easily create professional-looking Web sites in minutes. No knowledge of complex code is required, RapidWeaver will take care of... Read more
MacFamilyTree 7.5.2 - Create and explore...
MacFamilyTree gives genealogy a facelift: it's modern, interactive, incredibly fast, and easy to use. We're convinced that generations of chroniclers would have loved to trade in their genealogy... Read more

Rage of Bahamut is Giving Almost All of...
The App Store isn't what it used to be back in 2012, so it's not unexpected to see some games changing their structures with the times. Now we can add Rage of Bahamut to that list with the recent announcement that the game is severely cutting back... | Read more »
Adventures of Pip (Games)
Adventures of Pip 1.0 Device: iOS iPhone Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: ** ONE WEEK ONLY — 66% OFF! *** “Adventures of Pip is a delightful little platformer full of charm, challenge and impeccable... | Read more »
Divide By Sheep - Tips, Tricks, and Stre...
Who would have thought splitting up sheep could be so involved? Anyone who’s played Divide by Sheep, that’s who! While we’re not about to give you complete solutions to everything (because that’s just cheating), we will happily give you some... | Read more »
NaturalMotion and Zynga Have Started Tea...
An official sequel to 2012's CSR Racing is officially on the way, with Zynga and NaturalMotion releasing a short teaser trailer to get everyone excited. Well, as excited as one can get from a trailer with no gameplay footage, anyway. [Read more] | Read more »
Grab a Friend and Pick up Overkill 3, Be...
Overkill 3 is a pretty enjoyable third-person shooter that was sort of begging for some online multiplayer. Fortunately the begging can stop, because its newest update has added an online co-op mode. [Read more] | Read more »
Scanner Pro's Newest Update Adds Au...
Scanner Pro is one of the most popular document scanning apps on iOS, thanks in no small part to its near-constant updates, I'm sure. Now we're up to update number six, and it adds some pretty handy new features. [Read more] | Read more »
Heroki (Games)
Heroki 1.0 Device: iOS Universal Category: Games Price: $7.99, Version: 1.0 (iTunes) Description: CLEAR THE SKIES FOR A NEW HERO!The peaceful sky village of Levantia is in danger! The dastardly Dr. N. Forchin and his accomplice,... | Read more »
Wars of the Roses (Games)
Wars of the Roses 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: | Read more »
TapMon Battle (Games)
TapMon Battle 1.0 Device: iOS Universal Category: Games Price: $.99, Version: 1.0 (iTunes) Description: It's time to battle!Tap! Tap! Tap! Try tap a egg to hatch a Tapmon!Do a battle with another tapmons using your hatched tapmons! *... | Read more »
Alchemic Dungeons (Games)
Alchemic Dungeons 1.0 Device: iOS Universal Category: Games Price: $.99, Version: 1.0 (iTunes) Description: ### Release Event! ### 2.99$->0.99$ for limited time! ### Roguelike Role Playing Game! ### Alchemic Dungeons is roguelike... | Read more »

Price Scanner via MacPrices.net

13-inch 1.6GHz MacBook Air on sale for $849,...
Best Buy has the 2015 13″ 1.6GHz/128GB MacBook Air on sale for $849.99 on their online store this weekend. Choose free shipping or free local store pickup (if available). Sale price for online orders... Read more
Apple Refurbished iMacs available for up to $...
The Apple Store has Apple Certified Refurbished iMacs available for up to $380 off the cost of new models. Apple’s one-year warranty is standard, and shipping is free: - 27″ 3.5GHz 5K iMac – $1949 $... Read more
Apple refurbished 2014 13-inch Retina MacBook...
The Apple Store has Apple Certified Refurbished 2014 13″ Retina MacBook Pros available for up to $400 off original MSRP, starting at $979. An Apple one-year warranty is included with each model, and... Read more
Seagate Backup Plus Drives Feature 200GB of C...
Seagate Technology plc has announced that its Backup Plus family of external storage offerings will now include 200GB of OneDrive cloud storage, a major added value, and the addition of Lyve’s photo... Read more
Canon PIXMA MG3620 Wireless Inkjet All-in-One...
Canon U.S.A., Inc. has announced the PIXMA MG3620 Wireless (1) Inkjet All-in-One (AIO) printer for high-quality photo and document printing. Built with convenience in mind for the everyday home user... Read more
July 4th Holiday Weekend 13-inch MacBook Pro...
Save up to $150 on the purchase of a new 2015 13″ Retina MacBook Pro at the following resellers this weekend. Shipping is free with each model: 2.7GHz/128GB MSRP $1299 2.7GHz/... Read more
27-inch 3.5GHz 5K iMac on sale for $2149, sav...
Best Buy has the 27″ 3.5GHz 5K iMac on sale for $2149.99. Choose free shipping or free local store pickup (if available). Sale price for online orders only, in-store prices may vary. Their price is $... Read more
Apple now offering refurbished 2015 11-inch...
The Apple Store is now offering Apple Certified Refurbished 2015 11″ MacBook Airs as well as 13″ MacBook Airs (the latest models), available for up to $180 off the cost of new models. An Apple one-... Read more
15-inch 2.5GHz Retina MacBook Pro on sale for...
Amazon.com has the 15″ 2.5GHz Retina MacBook Pro on sale for $2274 including free shipping. Their price is $225 off MSRP, and it’s the lowest price available for this model. Read more
Finally Safe To Upgrade To Yosemite’?
The reason I’ve held back from upgrading my MacBook Air from OS X 10.9 Mavericks to 10.10 Yosemite for nearly a year isn’t just procrastination. Among other bugs reported, there have been persistent... Read more

Jobs Board

*Apple* Music Producer - Apple (United State...
**Job Summary** Apple Music seeks a Producer to help shepherd some of the most important content and editorial initiatives within the music app, with a particular focus Read more
Editor, *Apple* News - Apple (United States...
**Job Summary** Editor, Apple News The Apple News team is looking for passionate, knowledgeable editors to help identify and deliver the best in breaking national, Read more
*Apple* Watch SW Application Project Manager...
**Job Summary** The Apple Watch software team is looking for an Application Engineering Project Manager to work on new projects for Apple . The successful candidate Read more
Engineering Project Manager - *Apple* Searc...
**Job Summary** Apple 's new Spotlight Suggestions service provides fast, relevant search results from the Inte et in Spotlight and Safari on iOS and OS X. We are looking Read more
Business Development Manager - *Apple* Pay...
**Job Summary** Apple Pay is seeking an experienced relationship manager to support the ongoing management of partners for the Apple Pay platform. This position will Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.