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 Remote Desktop 3.8 - Remotely cont...
Apple Remote Desktop is the best way to manage the Mac computers on your network. Distribute software, provide real-time online help to end users, create detailed software and hardware reports, and... Read more
NeoOffice 2014.7 - 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
DesktopLyrics 2.6.6 - Displays current i...
DesktopLyrics is an application that displays the lyrics of the song currently playing in "iTunes" right on your desktop. The lyrics for the song have to be set in iTunes; DesktopLyrics does nothing... Read more
Ember 1.8.3 - Versatile digital scrapboo...
Ember (formerly LittleSnapper) is your digital scrapbook of things that inspire you: websites, photos, apps or other things. Just drag in images that you want to keep, organize them into relevant... Read more
Apple iTunes 12.1 - Manage your music, m...
Apple iTunes lets you organize and play digital music and video on your computer. It can automatically download new music, app, and book purchases across all your devices and computers. And it's a... Read more
LibreOffice 4.4.3 - Free, open-source of...
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
FoldersSynchronizer 4.2.1 - Synchronize...
FoldersSynchronizer is a popular and useful utility that synchronizes and backs-up files, folders, disks and boot disks. On each session you can apply special options like Timers, Multiple Folders,... Read more
Simon 4.0.2 - Monitor changes and crashe...
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
Cocktail 8.1.2 - General maintenance and...
Cocktail is a general purpose utility for OS X that lets you clean, repair and optimize your Mac. It is a powerful digital toolset that helps hundreds of thousands of Mac users around the world get... Read more
Cyberduck 4.6.4 - FTP and SFTP browser....
Cyberduck is a robust FTP/FTP-TLS/SFTP browser for the Mac whose lack of visual clutter and cleverly intuitive features make it easy to use. Support for external editors and system technologies such... Read more

Playworld Superheroes Review
Playworld Superheroes Review By Tre Lawrence on January 30th, 2015 Our Rating: :: HERO CRAFTINGUniversal App - Designed for iPhone and iPad It’s all about the imagination, fighting bad creatures — and looking good while doing so.   | Read more »
Join the SpongeBob Bubble Party in this...
Join the SpongeBob Bubble Party in this New Match 3 Bubble Poppin’ Frenzy Posted by Jessica Fisher on January 30th, 2015 [ permalink ] | Read more »
Handpick Review
Handpick Review By Jennifer Allen on January 30th, 2015 Our Rating: :: TANTALIZING SUGGESTIONSiPhone App - Designed for the iPhone, compatible with the iPad Handpick will make you hungry, as well as inspire you to cook something... | Read more »
Storm the Halls of Echo Base in First St...
Storm the Halls of Echo Base in First Star Wars: Galactic Defense Event Posted by Jessica Fisher on January 30th, 2015 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Contradiction Review
Contradiction Review By Tre Lawrence on January 30th, 2015 Our Rating: :: SPOT THE LIEiPad Only App - Designed for the iPad Contradiction is a live action point and click adventure that’s pretty engaging.   Developer: Tim Follin... | Read more »
Unlock Sunshine Girl in Ironkill with th...
Unlock Sunshine Girl in Ironkill with this special 148Apps code Posted by Rob Rich on January 29th, 2015 [ permalink ] Robo-fighter Ironkill has been out on iOS a | Read more »
Crossroad Zombies Review
Crossroad Zombies Review By Jordan Minor on January 29th, 2015 Our Rating: :: CROSSWALKING DEADiPad Only App - Designed for the iPad Crossroad Zombies is a rough draft of a cool genre mash-up.   | Read more »
Blood Brothers 2 – Tips, Cheats, and Str...
War is hell: Is it the kind of hell you want to check out? Read our Blood Brothers 2 review to find out! Blood Brothers 2, DeNA’s follow-up to the original Blood Brothers, is an intriguing card collecting / role-playing / strategy hybrid. There’s... | Read more »
Blood Brothers 2 Review
Blood Brothers 2 Review By Nadia Oxford on January 29th, 2015 Our Rating: :: AN AGGRAVATING RELATIVEUniversal App - Designed for iPhone and iPad Blood Brothers 2 is built on a simple, solid foundation, but its free-to-play system... | Read more »
I AM BREAD, the Toast of the Town, is Ro...
Have you ever dreamt of being deliciously gluten-y? Do you feel passionate about Rye and Wheat? The guys at Bossa Studios do and that is why they are bringing I AM BREAD to iOS soon. The loafy app will feature all the new content that is being... | Read more »

Price Scanner via MacPrices.net

Amazon offers 15-inch 2.2GHz Retina MacBook P...
 Amazon.com has the 15″ 2.2GHz Retina MacBook Pro on sale for $1879 including free shipping. Their price is $120 off MSRP, and it’s the lowest price available for this model from any reseller (except... Read more
Intel Aims to Transform Workplace With 5th-Ge...
Intel Corporation today announced the availability of its 5th generation Intel Core vPro processor family that provides cutting-edge features to enable a new and rapidly shifting workplace. To meet... Read more
iOS App Sharalike Introduces New Instant Smar...
Sharalike slideshow and photo management software for iOS, is making it easier than ever to create shareable meaningful moments with its new instant SmartShow technology. Staying organized is a goal... Read more
Apple Becomes World’s Largest Smartphone Vend...
According to the latest research data from Strategy Analytics, as global smartphone shipments grew 31 percent annually to reach a record 380 million units in the fourth quarter of 2014. Apple became... Read more
Cut the Cord: OtterBox Resurgence Power Case...
Dead batteries and broken phones are two of the biggest issues for smartphone users today. Otterbox addresses both with the new Resurgence Power Case for Apple iPhone 6, promising to make those panic... Read more
13-inch Retina MacBook Pros on sale for up to...
B&H Photo has 13″ Retina MacBook Pros on sale for $200 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 13″ 2.6GHz/128GB Retina MacBook Pro: $1199.99 save $100 - 13″ 2.6GHz/... Read more
15-inch 2.5GHz Retina MacBook Pro on sale for...
 B&H Photo has the 15″ 2.5GHz Retina MacBook Pro on sale for $2319.99 including free shipping plus NY sales tax only. Their price is $180 off MSRP, and it’s the lowest price available for this... Read more
Back in stock: Refurbished iPod nanos for $99...
The Apple Store has Apple Certified Refurbished 16GB iPod nanos available for $99 including free shipping and Apple’s standard one-year warranty. That’s $50 off the cost of new nanos. Most colors are... Read more
Apple lowers price on refurbished 256GB MacBo...
The Apple Store has lowered prices on Apple Certified Refurbished 2014 MacBook Airs with 256GB SSDs, now available for up to $200 off the cost of new models. An Apple one-year warranty is included... Read more
New Good Management Suite Simplifies Enterpri...
Good Technology has announced the availability of the Good Management Suite, a comprehensive cross-platform solution for organizations getting started with mobile business initiatives. Built on the... Read more

Jobs Board

At-Home Chat Specialist- *Apple* Online Stor...
**Job Summary** At Apple , we believe in hard work, a fun environment, and the kind of creativity and innovation that only comes about when talented people from diverse Read more
Sr. Mac Expert- *Apple* Online Store - Apple...
**Job Summary** The World Wide Apple Online Store (AOS) Sales and Service team is looking for motivated, outgoing, and tech savvy individuals who want to offer Apple Read more
*Apple* Solutions Consultant- Retail Sales (...
**Job Summary** The ASC is an Apple employee who serves as an Apple brand ambassador and influencer in a Reseller's store. The ASC's role is to grow Apple Read more
Event Director, *Apple* Retail Marketing -...
…This senior level position is responsible for leading and imagining the Apple Retail Team's global engagement strategy and team. Delivering an overarching brand Read more
At-Home Chat Specialist- *Apple* Online Stor...
**Job Summary** At Apple , we believe in hard work, a fun environment, and the kind of creativity and innovation that only comes about when talented people from diverse Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.