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

Motion 5.4.7 - Create and customize Fina...
Motion is designed for video editors, Motion 5 lets you customize Final Cut Pro titles, transitions, and effects. Or create your own dazzling animations in 2D or 3D space, with real-time feedback as... Read more
calibre 5.0.1 - Complete e-book library...
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
Compressor 4.4.8 - Adds power and flexib...
Compressor adds power and flexibility to Final Cut Pro X export. Customize output settings, work faster with distributed encoding, and tap into a comprehensive set of delivery features. Features:... Read more
Adobe Acrobat Reader 20.012.20048 - View...
Adobe Acrobat Reader allows users to view PDF documents. You may not know what a PDF file is, but you've probably come across one at some point. PDF files are used by companies and even the IRS to... Read more
Adobe Acrobat DC 20.012.20048 - Powerful...
Acrobat DC is available only as a part of Adobe Creative Cloud, and can only be installed and/or updated through Adobe's Creative Cloud app. Adobe Acrobat DC with Adobe Document Cloud services is... Read more
Box Sync 4.0.8009 - Online synchronizati...
Box Sync gives you a hard-drive in the Cloud for online storage. Note: You must first sign up to use Box. What if the files you need are on your laptop -- but you're on the road with your iPhone? No... Read more
Daylite 2020.36.1 - Dynamic business org...
Daylite helps businesses organize themselves with tools such as shared calendars, contacts, tasks, projects, notes, and more. Enable easy collaboration with features such as task and project... Read more
Catalina Cache Cleaner 15.0.6 - Clear ca...
Catalina Cache Cleaner is an award-winning general-purpose tool for macOS X. CCC makes system maintenance simple with an easy point-and-click interface to many macOS X functions. Novice and expert... Read more
Final Cut Pro X 10.4.10 - Professional v...
Final Cut Pro X is a professional video editing solution. Completely redesigned from the ground up, Final Cut Pro adds extraordinary speed, quality, and flexibility to every part of the post-... Read more
Civilization VI 1.3.4 - Next iteration o...
Civilization® VI is the award-winning experience. Expand your empire across the map, advance your culture, and compete against history’s greatest leaders to build a civilization that will stand the... Read more

Latest Forum Discussions

See All

Undercrawl is a procedurally generated r...
Undercrawl is a roguelike dungeon crawler from indie developer Monster Shop Games. It's a genre that's popular in gaming in general but features even more frequently on mobile devices since the shorter, 'run' style of playthrough suits playing in... | Read more »
Distract Yourself With These Great Mobil...
There’s a lot going on right now, and I don’t really feel like trying to write some kind of pithy intro for it. All I’ll say is lots of people have been coming together and helping each other in small ways, and I’m choosing to focus on that as I... | Read more »
BTS Universe Story, the social game that...
Netmarble's highly anticipated social game, BTS Universe Story, is available now for iOS and Android. It's the second collaboration between the hugely successful mobile developer and the K-pop superstars following BTS World. [Read more] | Read more »
The 5 Best Mobile Games Like Hades
Supergiant Games finally released Hades upon the world this week, and we’re loving it. The game plays to all of the studio’s strengths while still retaining a strong sense of identity. It also just so happens to play rather well using the Steam... | Read more »
A Year of Apple Arcade: The Good, The Ba...
Apple Arcade has persisted for just over a year at this point, and although that means I've been busy ranking and re-ranking every game on the service for just about as long, I haven't done much reflection on the service as a whole. [Read more] | Read more »
Animal Restaurant anniversary event team...
Animal idle simulator Animal Restaurant is celebrating its first-year anniversary with a crossover event with popular YouTube series Aaron’s Animals. [Read more] | Read more »
Raziel: Dungeon Arena is a hack 'n...
Raziel: Dungeon Arena is available now on mobile and will appeal to fans of both comic books and old school dungeon crawlers. Not only will you hack 'n' slash your way through mobs of enemies but there's also fully-narrated animated comic to enjoy... | Read more »
Steam Link Spotlight - Hades
Steam Link Spotlight is a feature where we look at PC games that play exceptionally well using the Steam Link app. Our last entry was on Disco Elysium. Read about how it plays using Steam Link over here. | Read more »
Microsoft has acquired ZeniMax Media and...
In the latest of a series of blockbuster moves, Microsoft has now acquired Zenimax Media and its subsidiary, Bethesda Softworks, for $7.5 billion. [Read more] | Read more »
Infinity Mechs is an upcoming idle game...
Indie developer SkullStar studio has announced an upcoming idle mech game called Infinity Mechs. It draws inspiration from the mobile game Iron Saga and has been officially licensed by Game Duchy. It's set to launch for both iOS and Android on... | Read more »

Price Scanner via MacPrices.net

Weekend’s Best MacBook Deal: These 2020 13″ M...
Apple has a full line of Certified Refurbished 2020 13″ 1.4GHz 4-Core Touch Bar MacBook Pros available starting at $1099 and up to $230 off original MSRP. Apple’s one-year warranty is included,... Read more
Clearance 8-core iMac Pro available for $3819...
Apple has Certified Refurbished, clearance, 27″ 3.2GHz 8-Core iMac Pros available $3819 including free shipping. Their price is $1180 off the original MSRP of new models. A standard Apple one-year... Read more
How The Upcoming Mac Transition To Apple Sili...
FEATURE: 09.25.20 – Apple’s plan to transition all of its desktop and notebook computers away from Intel processors to Apple silicon, chips designed by the company itself, has been eclipsed by the... Read more
New low price! Apple Watch SE for only $269
B&H Photo is reporting limited stock of Apple’s new Apple Watch SE GPS models for $10 off MSRP and including free shipping. Their $269 price for the 40mm model is the lowest price we’ve seen so... Read more
Lowest price anywhere: New 13″ 2.0GHz MacBook...
Amazon has new 2020 13″ 2.0GHz/512GB MacBook Pros with 10th generation Intel processors back in stock on sale today for $200 off Apple’s MSRP. Shipping is free. Be sure to purchase the MacBook Pro... Read more
Apple Pro Display XDR with Nano-Texture Glass...
Amazon Apple Premier Partner GatorTec has the Apple Pro Display XDR with Nano-Texture Glass on sale for $5599 shipped, on Amazon. Their price is $400 off Apple’s MSRP, and it’s the cheapest price... Read more
Get a 2019 13″ MacBook Air for only $779 toda...
Apple has clearance, Certified Refurbished, 2019 13″ 1.6GHz/128GB MacBook Airs available again for $779. Each MacBook features a new outer case, comes with a standard Apple one-year warranty, and is... Read more
2020 11″ iPad Pros on sale today for $50-$75...
Apple reseller Expercom has new 2020 11″ Apple iPad Pros on sale for $50-$75 off MSRP, with prices starting at $749. These are the same iPad Pros sold by Apple in their retail and online stores: – 11... Read more
Apple has restocked 2020 13″ MacBook Airs sta...
Apple has restocked Certified Refurbished 2020 13″ MacBook Airs starting at only $849 and up to $200 off the cost of new Airs. Each MacBook features a new outer case, comes with a standard Apple one-... Read more
Apple’s new 8th generation 10.2″ iPads are on...
Amazon is discounting new 2020 8th generation 10.2″ Apple iPads by up to $35 off MSRP with prices starting at only $299. Shipping is free. These are the same iPads sold by Apple in their retail and... Read more

Jobs Board

*Apple* Technology Journalist - Valnet Freel...
…freelance basis. Valnet Inc. is looking for journalists with strong knowledge of Apple technology for our website MakeUseOf.com MakeUseOf is one of the largest Read more
Bookseller- *Apple* Shop Support - Penn Sta...
…combination of education, certification and experience will be considered. + A+ and/or Apple certified or able to achieve certification within 60 days required. + Read more
Freelance *Apple* Technology Journalist - V...
…freelance basis. Valnet Inc. is looking for journalists with strong knowledge of Apple technology for our website MakeUseOf.com MakeUseOf is one of the largest Read more
*Apple* Certified Macintosh Technician - Exc...
Apple Certified Macintosh Technician Summary Title: Apple Certified Macintosh Technician ID:350 Department:All Location:Bethesda, MD Description Apple Read more
Security Officer ($23.00/Hourly) - *Apple*...
**Security Officer \($23\.00/Hourly\) \- Apple Store** **Description** About NMS Built on a culture of safety and integrity, NMSdelivers award\-winning, integrated Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.