search

a2stuff / a2d

Disassembly of the Apple II Desktop - ProDOS GUI
https://a2desktop.com
278 stars 20 forks source link

Documentation Issues #681

Closed inexorabletash closed 2 years ago

inexorabletash commented 2 years ago

This is an issue for collecting problems noted in documentation, including:

Instead of filing a separate bug, please add comments here. Make the comments as short as possible.

inexorabletash commented 2 years ago

Thanks. I left the accelerator order alone, as the ZIP CHIP is more popular/relevant than the other two.

c0mmander8 commented 2 years ago

What about "TransWarp I" replacing "Transwarp I" and "UltraWarp" replacing "Ultrawarp"?

Apple II DeskTop "Docs" documentation, located at https://www.a2desktop.com/docs, string changes:

"Shows Normal and Fast buttons. On systems with built-in accelerators (Apple IIgs, IIc Plus, IIe Option Card for Macintosh, Laser 128EX) or some add-on accelerators (FASTChip //e, ZIP CHIP, Transwarp I, Ultrawarp), this selects between the standard 1MHz speed and the accelerator's fastest speed." should instead be "Shows Normal and Fast buttons. On systems with built-in accelerators (Apple IIgs, IIc Plus, IIe Option Card for Macintosh, Laser 128EX) or some add-on accelerators (FASTChip //e, ZIP CHIP, TransWarp I, UltraWarp), this selects between the standard 1MHz speed and the accelerator's fastest speed.", with the phrase "TransWarp I" replacing the phrase "Transwarp I" and the word "UltraWarp" replacing the word "Ultrawarp", for accuracy in the Apple II DeskTop documentation.

inexorabletash commented 2 years ago

Ah, thanks for calling out the casing. If you can write shorter descriptions, it would be easier to understand. For example, just write:

Replace: "Transwarp I" With: "TransWarp I"

This is much easier to read than a long paragraph.

c0mmander8 commented 2 years ago

a2d/docs/HIG.md "Human Interface Guidelines", located at https://github.com/a2stuff/a2d/blob/main/docs/HIG.md, string changes:

Under "List Box Controls", under "The following keyboard shortcuts are supported:":

"Apple+Up/Down - scroll by one page." should instead be "Apple+Up/Down Arrow - scroll by one page.", with the phrase "Up/Down Arrow" replacing the phrase "Up/Down", in order to match the rest of the Arrow key entries in the Apple II DeskTop "Human Interface Guidelines".

Replace: "Up/Down" With: "Up/Down Arrow"

"Open-Apple+Solid-Apple+Up/Downshould - move selection or scroll to start/end." should instead be "Open-Apple+Solid-Apple+Up/Down Arrow - move selection or scroll to start/end.", with the phrase "Up/Down Arrow" replacing the phrase "Up/Downshould", in order to match the rest of the Arrow key entries in the Apple II DeskTop "Human Interface Guidelines".

Replace: "Up/Downshould" With: "Up/Down Arrow"

Under "Keyboard":

"For Apple+letter combinations, Open Apple or Solid Apple should be equivalent." should instead be "For Apple+letter combinations, Open-Apple or Solid-Apple should be equivalent.". with the phrase "Open-Apple or Solid-Apple" replacing the phrase "Open Apple or Solid Apple", in order to match the rest of the Open-Apple key and Solid-Apple key entries in the Apple II DeskTop "Human Interface Guidelines".

Replace: "Open Apple or Solid Apple" With: "Open-Apple or Solid-Apple"