home *** CD-ROM | disk | FTP | other *** search
/ NetNews Usenet Archive 1992 #16 / NN_1992_16.iso / spool / comp / sys / next / programm / 5382 < prev    next >
Encoding:
Text File  |  1992-07-31  |  6.7 KB  |  182 lines
  1. Newsgroups: comp.sys.next.programmer
  2. Path: sparky!uunet!psinntp!afs!greg
  3. From: greg@afs.com (Gregory H. Anderson)
  4. Subject: Summary of FAQ organization suggestions
  5. Message-ID: <1992Jul30.153454.1512@afs.com>
  6. Keywords: FAQ
  7. Sender: greg@afs.com
  8. Reply-To: greg@afs.com
  9. Date: Thu, 30 Jul 1992 15:34:54 GMT
  10. Lines: 170
  11.  
  12. Again, thanks to everyone for your overwhelmingly positive response to  
  13. Anderson Financial Systems' offer to maintain the c.s.n.programmer FAQ.  
  14. Here are some preliminary ideas about how to organize this information.
  15.  
  16. There should be separate FAQs for the following broad topics:
  17.  
  18.     1. Programming tools and utilities (including IB, PB, gcc, etc.)
  19.  
  20.     2. The main appkit - standard classes we know and love
  21.  
  22.     3. DBKit - This is going to be confusing, buggy, and HotHotHot
  23.     
  24.     4. Other kits (SoundKit, IndexingKit, PhoneKit, etc.) - over time,  
  25. this may get broken down further as individual sections grow
  26.  
  27.     5. PostScript and Renderman
  28.  
  29.     6. Application development issues - integrating this pile of Lego  
  30. into interesting, functional programs. IMHO, this is the least well  
  31. documented topic in the standard sources, and the one from which we can  
  32. all benefit the most.
  33.  
  34. Ideas for each FAQ are presented in the following sections. Our overriding  
  35. goal is to provide useful, integrated information that does not overlap  
  36. commonly available sources, such as NeXT's published documentation.
  37.  
  38. -------------------------------
  39. Programming tools and utilities
  40. -------------------------------
  41. Separate sections for IB, ProjectBuilder, HelpBuilder, compiler, gdb,  
  42. other programs in /NextDeveloper/Apps. Known bugs, common pitfalls.
  43.  
  44. Objective-C - common questions, NeXT vs StepStone implementation, issues  
  45. relating to the runtime system
  46.  
  47. Palettes - how to build them, implementing the right read/write/awake/init  
  48. methods, common pitfalls, debugging, 2.x vs 3.0.
  49.  
  50. Makefile maintenance
  51.  
  52. Localization issues
  53.  
  54. -----------
  55. Main appkit
  56. -----------
  57. The main appkit FAQ looks like the most complicated. The hardest part is  
  58. how to make it useful without restating a lot of information that is  
  59. already available in the NeXT docs. We propose to subdivide the main  
  60. appkit FAQ by object class, with the following possible topics in each  
  61. subsection:
  62.  
  63.     1. Typical uses, alternatives, tricks
  64.     2. Common pitfalls and shortcomings
  65.     3. Known bugs
  66.     4. New or fixed in 3.0
  67.     4. A short inline example, or location in /NextDeveloper/Examples
  68.     6. Available ObjectWare - published or PD subclasses
  69.  
  70. To keep the size of this FAQ under control, only objects for which FAQs  
  71. are required, and within each object listing only subtopics which have  
  72. significant commentary, will be included.
  73.  
  74. Here's an example, with notes in []:
  75. -------------------------------------------------------------------------
  76. Button (Control : View : Responder : Object)
  77.  
  78. Typical uses, alternatives, tricks: 
  79.     Uses: Push buttons, for signaling user actions; checkboxes, for  
  80. reflecting the current state of yes/no and on/off choices. 
  81.     Alternatives: Radio buttons or pop-up buttons should be used for  
  82. other multiple-state choices, even two-state choices which are not clearly  
  83. yes/no or on/off.
  84.     Tricks: Unbordered Buttons can be used in place of static  
  85. TextField labels to trigger 'hidden UI' actions on mouse clicks. For  
  86. example, clicking on the label (which is actually a Button) next to an  
  87. editable TextField might bring up a find panel specific to that field.
  88.     [other cool stuff]
  89.     
  90. Common pitfalls and shortcomings:
  91.     Checkboxes do not have a keyboard equivalent to toggle the state  
  92. and cannot be Tabbed into (and out of) from TextFields.
  93.     [Other common gotchas that show up on the Net all the time. For  
  94. PopUpList, talk about how IB is a little braindead in the way it handles  
  95. popups. Then the Example subtopic would show some code of how to  
  96. circumvent.]
  97.     
  98. Known bugs:
  99.     None
  100.     [These would be from NeXTanswers or user reports on the Net]
  101.     [In reality, if there were no known bugs 8^), this subtopic would  
  102. be omitted to save space]
  103.     
  104. New or fixed in 3.0: 
  105.     Nothing, but see ButtonCell for a fix about icon placement.
  106.     [This would be a quick synopsis of new or replaced methods]
  107.     
  108. Example: 
  109.     /NextDeveloper/Examples/BusyBox
  110.     [Actual cut-and-paste code might appear here for common problems,  
  111. or if there are no /NextDeveloper/Examples]
  112.  
  113. Available ObjectWare:
  114.     AfsButton (Anderson Financial Systems), adds nextText and  
  115. previousText instance variables so that push buttons and checkboxes can be  
  116. included in the text editing loop; when first responder, listens for  
  117. spacebar as the equivalent of a mouse click.
  118.     Afs3DButton (AFS), remembers the coordinates of the last mouse  
  119. click to pass as 3D viewpoint
  120.     NiftyButton (NightShade Software), draw in freeform shapes
  121.     [Other published or PD objects which derive from this class -  
  122. sorry this one reads like a commercial]
  123. -------------------------------------------------------------------------
  124.  
  125. -----------
  126. DatabaseKit
  127. -----------
  128. Similar to the main appkit approach.
  129. Sections about adaptors - writing and using
  130. DBModeler
  131.  
  132. ----------
  133. Other kits
  134. ----------
  135. Similar to the main appkit approach.
  136.  
  137. ------------------------
  138. PostScript and Renderman
  139. ------------------------
  140. For specific operators, as needed:
  141.     Known bugs
  142.     Performance hints
  143.     Common pitfalls
  144.     
  145. -----------------------
  146. Application Development
  147. -----------------------
  148.     Designing stable, modular apps and object kits
  149.     User interface issues (forms-based apps, for example)
  150.     Subclassing decisions
  151.     Delegates/controllers vs subclasses
  152.     Dynamic class loading
  153.     Resources - books, articles, tutorials
  154.     API issues/clearinghouse - This is a particular favorite for me.  
  155. I'd like for all active NeXT developers to have a clearinghouse for  
  156. inter-app functionality, with a forum for the best ways to  
  157. inter-communicate. Remember, apps are just complex objects!
  158.  
  159.  
  160. Whew! Tired of reading yet? An unresolved question is whether to keep this  
  161. in plain ASCII text, or RTF for nicer displays in DigitalLibrarian. I only  
  162. want to maintain this in one format, so the answer is important. I  
  163. personally vote for RTF unless enough people would feel disenfranchised.
  164.  
  165. I'm going to pull c.s.n.programmer off the archives and start sifting  
  166. through the common threads. If you have anything to contribute that has  
  167. not been on the Net, I'd love to include it. All contributions will be  
  168. credited in place.
  169.  
  170. As usual, your comments are eagerly anticipated. In particular, I'd like  
  171. to know if there is general agreement about the six FAQ subdivisions and  
  172. the list of subtopics within each one.
  173.  
  174. greg@afs.com
  175.  
  176.  
  177. --
  178. Gregory H. Anderson          | "We're very tolerant around here,
  179. Benevolent Dictator-for-Life |  being only amateurs ourselves."
  180. Anderson Financial Systems   | - Tortoise (Godel, Escher, Bach)
  181. greg@afs.com  (Nextmail OK)  | 
  182.