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/.

 
AAPL
$111.78
Apple Inc.
-0.87
MSFT
$47.66
Microsoft Corpora
+0.14
GOOG
$516.35
Google Inc.
+5.25

MacTech Search:
Community Search:

Software Updates via MacUpdate

NeoOffice 2014.6 - Mac-tailored, OpenOff...
NeoOffice is a complete office suite for OS X. With NeoOffice, users can view, edit, and save OpenOffice documents, PDF files, and most Microsoft Word, Excel, and PowerPoint documents. NeoOffice 3.x... Read more
LibreOffice 4.3.5.2 - Free Open Source o...
LibreOffice is an office suite (word processor, spreadsheet, presentations, drawing tool) compatible with other major office suites. The Document Foundation is coordinating development and... Read more
CleanApp 5.0.0 Beta 5 - Application dein...
CleanApp is an application deinstaller and archiver.... Your hard drive gets fuller day by day, but do you know why? CleanApp 5 provides you with insights how to reclaim disk space. There are... Read more
Monolingual 1.6.2 - Remove unwanted OS X...
Monolingual is a program for removing unnecesary language resources from OS X, in order to reclaim several hundred megabytes of disk space. It requires a 64-bit capable Intel-based Mac and at least... Read more
NetShade 6.1 - Browse privately using an...
NetShade is an Internet security tool that conceals your IP address on the web. NetShade routes your Web connection through either a public anonymous proxy server, or one of NetShade's own dedicated... Read more
calibre 2.13 - Complete e-library manage...
Calibre is a complete e-book library manager. Organize your collection, convert your books to multiple formats, and sync with all of your devices. Let Calibre be your multi-tasking digital librarian... Read more
Mellel 3.3.7 - Powerful word processor w...
Mellel is the leading word processor for OS X and has been widely considered the industry standard since its inception. Mellel focuses on writers and scholars for technical writing and multilingual... Read more
ScreenFlow 5.0.1 - Create screen recordi...
Save 10% with the exclusive MacUpdate coupon code: AFMacUpdate10 Buy now! ScreenFlow is powerful, easy-to-use screencasting software for the Mac. With ScreenFlow you can record the contents of your... Read more
Simon 4.0 - Monitor changes and crashes...
Simon monitors websites and alerts you of crashes and changes. Select pages to monitor, choose your alert options, and customize your settings. Simon does the rest. Keep a watchful eye on your... Read more
BBEdit 11.0.2 - Powerful text and HTML e...
BBEdit is the leading professional HTML and text editor for the Mac. Specifically crafted in response to the needs of Web authors and software developers, this award-winning product provides a... Read more

Latest Forum Discussions

See All

Make your own Tribez Figures (and More)...
Make your own Tribez Figures (and More) with Toyze Posted by Jessica Fisher on December 19th, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
So Many Holiday iOS Sales Oh My Goodness...
The holiday season is in full-swing, which means a whole lot of iOS apps and games are going on sale. A bunch already have, in fact. Naturally this means we’re putting together a hand-picked list of the best discounts and sales we can find in order... | Read more »
It’s Bird vs. Bird in the New PvP Mode f...
It’s Bird vs. Bird in the New PvP Mode for Angry Birds Epic Posted by Jessica Fisher on December 19th, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Telltale Games and Mojang Announce Minec...
Telltale Games and Mojang Announce Minecraft: Story Mode – A Telltale Games Series Posted by Jessica Fisher on December 19th, 2014 [ permalink ] | Read more »
WarChest and Splash Damage Annouce Their...
WarChest and Splash Damage Annouce Their New Game: Tempo Posted by Jessica Fisher on December 19th, 2014 [ permalink ] WarChest Ltd and Splash Damage Ltd are teaming up again to work | Read more »
BulkyPix Celebrates its 6th Anniversary...
BulkyPix Celebrates its 6th Anniversary with a Bunch of Free Games Posted by Jessica Fisher on December 19th, 2014 [ permalink ] BulkyPix has | Read more »
Indulge in Japanese cuisine in Cooking F...
Indulge in Japanese cuisine in Cooking Fever’s new sushi-themed update Posted by Simon Reed on December 19th, 2014 [ permalink ] Lithuanian developer Nordcurrent has yet again updated its restaurant simulat | Read more »
Badland Daydream Level Pack Arrives to C...
Badland Daydream Level Pack Arrives to Celebrate 20 Million Downloads Posted by Ellis Spice on December 19th, 2014 [ permalink ] | Read more »
Far Cry 4, Assassin’s Creed Unity, Desti...
Far Cry 4, Assassin’s Creed Unity, Destiny, and Beyond – AppSpy Takes a Look at AAA Companion Apps Posted by Rob Rich on December 19th, 2014 [ permalink ] These day | Read more »
A Bunch of Halfbrick Games Are Going Fre...
A Bunch of Halfbrick Games Are Going Free for the Holidays Posted by Ellis Spice on December 19th, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »

Price Scanner via MacPrices.net

13-inch 2.6GHz Retina MacBook Pro on sale for...
Best Buy has lowered their price on the 2014 13″ 2.6GHz/128GB Retina MacBook Pro to $1149.99 on their online store for a limited time. That’s $150 off MSRP and the lowest price available for this... Read more
Kodak Returns to CES With New Consumer Produ...
Former photography colossus Kodak is returning to CES for the first time in three years where the Kodak booth (#21818 South Hall 1) will showcase a wide range of innovative, imaging-related products... Read more
Invaluable Launches New Eponymously -Named A...
Invaluable, the world’s largest online live auction marketplace, hhas announced the official launch of the Invaluable app for iPad, now available for download in the iTunes App Store. Invaluable... Read more
IDC Reveals Worldwide Mobile Enterprise Appli...
International Data Corporation (IDC) last week hosted the IDC FutureScape: Worldwide Mobile Enterprise Applications and Solutions 2015 Predictions Web conference. The session provided organizations... Read more
Hello Vino Wine App Launches “Safe Ride Home”...
Hello Vino has announced addition of a new “Get a Safe Ride Home” feature in its Food & Drink app with a direct connection to Uber, the technology platform that connects users with rides. The... Read more
DEVON-technologies Releases DEVONthink To Go...
Coeur d’Alene, Idaho based DEVON-technologies, LLC has updated DEVONthink To Go, its mobile companion to DEVONthink, to version 1.5. The update includes an iOS 8 extension, compatibility with the... Read more
The Apple Store offering free next-day shippi...
The Apple Store is now offering free next-day shipping on all in stock items if ordered before 12/23/14 at 10:00am PT. Local store pickup is also available within an hour of ordering for any in stock... Read more
It’s 1992 Again At Sony Pictures, Except For...
Techcrunch’s John Biggs interviewed a Sony Pictures Entertainment (SPE) employee, who quite understandably wished to remain anonymous, regarding post-hack conditions in SPE’s L.A office, explaining “... Read more
OtterBox Defender Series Case For iPad mini 3...
With their innovative Touch ID technology and ultrathin profile, the latest tranche of Apple iPads are more desirable than ever, and OtterBox has just announced the Defender Series custom-engineered... Read more
Holiday sales this weekend: MacBook Pros for...
 B&H Photo has new MacBook Pros on sale for up to $300 off MSRP as part of their Holiday pricing. Shipping is free, and B&H charges NY sales tax only: - 15″ 2.2GHz Retina MacBook Pro: $1699... Read more

Jobs Board

*Apple* Store Leader Program (US) - Apple, I...
…Summary Learn and grow as you explore the art of leadership at the Apple Store. You'll master our retail business inside and out through training, hands-on experience, Read more
Project Manager, *Apple* Financial Services...
**Job Summary** Apple Financial Services (AFS) offers consumers, businesses and educational institutions ways to finance Apple purchases. We work with national and Read more
*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
*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
*Apple* Retail - Multiple Positions (US) - A...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.