Das endgültige ATARI-Referenzhandbuch

1, 2

Das endgültige ATARI-Referenzhandbuch

von FlorianD » So 22. Jul 2007, 00:50
Hallo,

immer wieder stoße ich beim Programieren auf Dokumentationslücken. Profibuch, DeReAtari, ATARI intern, usw. Alle ganz gut, aber nie komplett und manche auch voller Fehler und gegenseitig widersprüchlich.

Wie wäre es, wenn wir gemeinsam ein neues, komplettes, fehlerfreies Buch schreiben? Vielleicht als HTML, damit man es schön untereinander verlinken kann? Oder als Wiki, dann können alle gut mitmachen?

Ich stelle mir sowas wie den Speicherplan vom ATARI Intern vor. Eine Speicherstelle nach der anderen, mit (offiziellen) Namen (oder mehreren), Hex, Dez, -angaben, Bits und ihre Funktion in Tabellen, verweise vor und zurück bei Schattenregistern und verwandten Registern (z.B. die mit den Tastaturcodes etc. oder die Interruptsteuerung). Das ganze dann versehen mit (überprüften)Beispielen in verschiedenen Programmiersprachen.

Zum Schluß die üblichen Tabellen mit Zeichencodes intern und Ascii und Atascii, anzugebenden Werten für Gr.1 und Gr.2 usw. Errorcodes mit Erweiterungen aus anderen DOSsen. und was alles noch.

Die Printausgabe vielleicht Print-On-Demand.

Wäre das eine Idee? Wer hat Erfahrung mit Dokumentation Schreiben? Wie geht man da am besten vor?

Viele Grüße,
Florian

von Schuster » So 22. Jul 2007, 18:57
Hallo Florian,

eine sehr gute Idee, die ich auch schon länger mit mir herumtrage.
Wie du schon sagtest braucht man beim Programmieren immer mehrere Handbücher um zu einem Thema alle Details zu haben.

Die Vorgehensweise wie im Atari Intern finde ich auch sehr gut.
Bei den Programmbeispielen wäre es schön wenn es auch einen Index gäbe wo diese Speicherstelle im OS benutzt wird und warum, kann vielleicht dann auch als Beispiel herhalten.

Was mir manchmal fehlt in den ganzen Büchern sind voll durchgängi erklärte Beispiele von nicht vollständig im OS implementierten Features des Atari (PBI, D5xx) vielleicht dann irgendwann auch mit Exkursen zu möglichen Hardware Beispielen.

Auch Programmiertricks die gezielt die Fähigkeiten und "Fehler" der Atari Customchips ausnutzen, also sehr Hardware nahe Prgrammbeispiele.

Zum Vorgehen denke ich das man sich am Inaltsverzeichnis des Atari Intern halten kann und versucht zu jedem Punkt den bekannten Wissensstand zu sammeln. Ich denke über ein WIKI wäre dies amschnellsten zu realisieren.
Außerdem haben wir ja schon ein WIKI welches man nutzen könnte bzw. dessen Inhalte schon entsprechend verlinkt werden könnten.

Mal sehen was die Anderen dazu sagen.

Gruß
Frank

von cas » Mo 23. Jul 2007, 13:55
Das Atari Wiki (unter www.strotmann.de) wird am 6. August auf einen neuen Server mit einer neuen Wiki-Software umziehen.

Meine Idee war es von Anfang an gewesen, das sich die Benutzer aus den einzelnen Wiki-Artikeln ein persönliches Referenzhandbuch zusammenstellen könne.

Die Idee ist das die Benutzer sich Artikel aus dem Wiki in ein perönliches Referenzhandbuch übernehmen können (wer z. B. nie unter Sparta DOS X programmiert braucht diese Informationen nicht, wärend ein ACTION! Programmierer nicht auf die BASIC Speicherstellen "scharf" ist.

Dieses "perönliche" Refertenzhandbuch kann dann als PDF geladen werden (inkl. Inhaltsverzeichnis und Index) und entweder selbst ausgedruckt, am Bildschirm gelesen oder per Print-on-Demand bestellt werden (wobei hier geschaut werden muss welcher POD Anbieter echten "Einzelasugaben"-Druck anbietet, da jede Ausgabe von der vorherigen Unterschieden wäre. Man kann aber auch eine "standard" Version des Referenzhandbuchs als POD vorstellen.

Eine Sortierung nach Speicherstellen ist eine der möglichen Sortierungen. Das Profibuch hat schon versucht zwei Zugriffs-Arten zu bieten (nach Speicherstellen und nach Themen). Das neue Wiki sollte so flexibel sein, mehrere Zugriffsarten zu bieten (nach System, Speicherstellen, Themen, Programmbeispielen, Programmiersprachen etc etc etc).

@Florian: können wir am 6.8. bei Dir besprechen.

Carsten

von guus » Mo 23. Jul 2007, 21:33
Prima Idee.
Schau auch mal nach
http://atariki.krap.pl/index.php/Strona ... 2%C3%B3wna

Es wäre auch wichtig um Sachen wie Blackbox, IDE u.s.w zu beschreiben.

mfg.
Guus

von FlorianD » Di 24. Jul 2007, 23:28
das ziemlich gute REFMAN von Bob Duhamel sollten wir auch nicht vergessen. Recht komplett, aber es fehlt die Verlinkung, die es perfekt macht.
siehe hier: http://evilbill.org/Atari/8-Bit/Refman/refman.html

Ich dachte an Daten wie
53279 $D01F (Rev.A 53279 $D01F)
CONSOL, und andere Namen wenn vorhanden

Bits
H L
x x x x x x x x
0 0 0 0 L O S S
S P E T
LS Lautsprecher
OP option
SE Select
ST Start
Standardwert 7
Je Bit=1 wenn nicht gedrückt, 0 wenn gedrückt
zB
6 wenn START gedrückt
5 wenn Select gedrückt
3 wenn Option gedrückt

wenn man Bit 4 an und ausschaltet, klickt der eingebaute Lautsprecher. Bit 4 wird immer als 0 gelesen

siehe auch HELPFG, 732 ($02DC)
etc.

Programmierbeispiele:
...

muß man natürlich noch einheitlich formatieren, damit es nachher gut und einheitlich aussieht.

von FlorianD » Fr 27. Jul 2007, 22:29
Hallo.

ich habe einfach mal angefangen. Hier ist die Einstiegsseite, dort sollen später alle Speicherstellen und Register der Reihe nach $0000-$FFFF aufgelistet werden.

CONSOL (Start,Select,Option) habe ich schon mal als Beispiel geschrieben. Formatiert ist noch nichts groß, ich denke, das wird sich mit der zeit finden, wie das am besten geht.

Programmierbeispiele sind in allen(!) Sprachen willkommen. Je mehr desto besser. Ggf. auch Extraseite auslagern.

Bei jedem Eintrag sollte ganz unten stehen
Siehe auch:
-(weitere Register, die nahe verwandt sind)
-eine Themenübersicht (in diesem Fall z.B. alles was mit Tastatur zu tun hat)
-ein Link zur Gesamtübersicht


http://www.strotmann.de/twiki/bin/view/ ... OSHandbook

Mal gucken, wie lange es dauert bis das komplett ist.

Und, nein, es gibt keinen Preis für die meisten Beiträge :-) Aber eine Erwähnung im Impressum.

Viele Grüße,
Florian

von cas » Sa 28. Jul 2007, 12:35
Hi,

ich hatte eine solche Tabelle 1991 schon mal für den Eigengebrauch erstellt. Gut, wenn man alles aufhebt. Ich musste zwar Windows 3.1 starten um die Daten lesen zu können (altes MS Write Format), aber es hat geklappt. Dann ein kleines Programm um die Datein in Wiki-Tabellenform zu bekommen, und hier ist die Tabelle

http://www.strotmann.de/twiki/bin/view/ ... dbookPages

Carsten

von cas » So 29. Jul 2007, 22:08
Hier ein paar Screenshots vom neuen Wiki und der Referenz-Tabellen-Anwendung.

Die Speicherstellen werden per Eingabemaske eingetragen, die Tabelle aktualisiert sich automatisch.

http://strotmann.de/twiki/bin/view/APG/XwikiNew

Ciao

Carsten

von FlorianD » Mi 1. Aug 2007, 23:37
Hallo,

ich stelle das Projekt hiermit zurück, bis cas das neue WiKi installiert hat.

Grüße,
Florian

Re

von sdleidel » Mi 12. Sep 2007, 23:05
Print on Demand ist kein Problem....


Sascha

von eda70 » Do 26. Mär 2009, 18:12
Was ist aus der _Holy Bible of A8_ geworden?
Finde die Idee gut. 8)
(Hat wohl schon jeder mal gehabt... :wink: )

von FlorianD » Sa 28. Mär 2009, 23:27
Hallo,

irgendwie sind wir mi dem Wiki aufsetzen hängen geblieben (Carsten, korrigier mich wenn ich es falsch wiedergebe) weil es manche Funktionen nicht so machte wie es sollte.

Ich nutze diese Bücher (mit vielen Anmerkungen drin) in dieser Reihenfolge:
-Mapping the ATARI (gibts im Internet, z.b. atariarchives.org)
-Atari reference bob-duhamel (google mal danach)
-De Re ATARI (atariarchives.org)
-Das ABBUC Technik Handbuch (hier im Shop)
-Das XL/XE Addendum von ATARI (Internet)

"ATARI Intern" von Data Becker ist voller Fehler und schlecht strukturiert, daher fast unbrauchbar.

Damit kommt man gut hin.

Dies hier ist auch gut:
Atari Graphics and Arcade Game Design (atariarchives.org)

Grüße,
Florian

von FlorianD » Sa 28. Mär 2009, 23:28
Hallo,

irgendwie sind wir mi dem Wiki aufsetzen hängen geblieben (Carsten, korrigier mich wenn ich es falsch wiedergebe) weil es manche Funktionen nicht so machte wie es sollte.

Ich nutze diese Bücher (mit vielen Anmerkungen drin) in dieser Reihenfolge:
-Mapping the ATARI (gibts im Internet, z.b. atariarchives.org)
-Atari reference bob-duhamel (google mal danach)
-De Re ATARI (atariarchives.org)
-Das ABBUC Technik Handbuch (hier im Shop)
-Das XL/XE Addendum von ATARI (Internet)

"ATARI Intern" von Data Becker ist voller Fehler und schlecht strukturiert, daher fast unbrauchbar.

Damit kommt man gut hin.

Dies hier ist auch gut:
Atari Graphics and Arcade Game Design (atariarchives.org)

Grüße,
Florian

von cas » So 29. Mär 2009, 22:53
FlorianD hat geschrieben:Hallo,

irgendwie sind wir mi dem Wiki aufsetzen hängen geblieben (Carsten, korrigier mich wenn ich es falsch wiedergebe) weil es manche Funktionen nicht so machte wie es sollte.


Hi,

das neue Wiki gibt es seit September 2007 unter http://atariwiki.org

Die gewünschte Funktion ist unter dem Programmpunkt "Memory Map" auf der rechten Seite im Menü. Ich habe dort einige Beispiele eingetragen.

Unter http://atariwiki.strotmann.de/xwiki/bin/view/MemoryMap/
gibt es eine Übersicht aller bisher erfassten Speicherstellen.

Unter "Add a new Memory Cell Reference" kann man einen neuen Eintrag erstellen. Dazu den Namen der Speicherstelle im Textfeld "Document" eintragen und auf "Create a new Memory Map Entry" clicken. Dann das Formular ausfüllen, probeweise anschauen und dann speichern.

Da es ein Wiki ist kann jeder angemeldete Benutzer die Informationen erweitern oder korrigieren.

von eda70 » Do 7. Mai 2009, 15:20
Hm, also wenn ich ehrlich bin, finde ich die MemoryMap im Wiki nicht so berauschend.
Ich fände ein pdf besser, da man es auch offline zur Verfügung hat und bei Bedarf drucken kann.
Die Suche im Wiki geht immer über alles und kann nicht bspw. auf die MemoryMap eingeschränkt werden.
Des weiteren ist mir natürlich deutsch lieber als englisch.

Welches Standardwerk könnte denn als Ausgangspunkt dienen und erweitert werden? Das Profibuch?

von cas » Do 7. Mai 2009, 23:09
eda70 hat geschrieben:Hm, also wenn ich ehrlich bin, finde ich die MemoryMap im Wiki nicht so berauschend.
Ich fände ein pdf besser, da man es auch offline zur Verfügung hat und bei Bedarf drucken kann.
Die Suche im Wiki geht immer über alles und kann nicht bspw. auf die MemoryMap eingeschränkt werden.
Des weiteren ist mir natürlich deutsch lieber als englisch.

Welches Standardwerk könnte denn als Ausgangspunkt dienen und erweitert werden? Das Profibuch?


Das Wiki ist so geplant das man sich von der Memory Map immer ein aktuelles PDF erstellen lassen kann (mit Inhaltsverzeichnis und Index) und dann ausdrucken und neben den Atari legen kann.

Ein PDF/Word/OpenOffice Dokument ist zu statisch und kann nicht zentral von vielen Leuten aktualisiert werden (z. B. die Liste der Erweiterungen die Speicheradressen im IO Bereich benutzen).

Das Wiki so wie es jetzt ist ist auch nur eine pre-Alpha version. Ich brauche Rückmeldung wie es denn sein soll.

Ciao

Carsten

von eda70 » Fr 8. Mai 2009, 16:35
cas hat geschrieben:Das neue Wiki sollte so flexibel sein, mehrere Zugriffsarten zu bieten (nach System, Speicherstellen, Themen, Programmbeispielen, Programmiersprachen etc etc etc).


Habe nicht gesehen, wie man sortieren/selektieren kann.

Das wären auch meine Punkte. Topics nach System selektieren und frei sortieren.
Stellt sich nur noch die Frage nach der Sprache.
Ich persönlich finde ja Dt. am besten (kann ich halt einigermassen) Engl. ist wahrscheinlich für evtl. internationale Nutzer interessant, wenn es welche gibt.

Letztendlich steht und fällt sowas ja mit dem Interesse weiterer Beteiligter.
Auch läßt sich mit dieser Tabelle 'nur' die MamoryMap umsetzten oder lassen sich auch weitere Inhalte umsetzten?

von cas » Fr 8. Mai 2009, 16:42
eda70 hat geschrieben:
cas hat geschrieben:Das neue Wiki sollte so flexibel sein, mehrere Zugriffsarten zu bieten (nach System, Speicherstellen, Themen, Programmbeispielen, Programmiersprachen etc etc etc).


Habe nicht gesehen, wie man sortieren/selektieren kann.

Das wären auch meine Punkte. Topics nach System selektieren und frei sortieren.
Stellt sich nur noch die Frage nach der Sprache.
Ich persönlich finde ja Dt. am besten (kann ich halt einigermassen) Engl. ist wahrscheinlich für evtl. internationale Nutzer interessant, wenn es welche gibt.

Letztendlich steht und fällt sowas ja mit dem Interesse weiterer Beteiligter.
Auch läßt sich mit dieser Tabelle 'nur' die MamoryMap umsetzten oder lassen sich auch weitere Inhalte umsetzten?


Meine Idee ist das sich Anwender aus den Atari-Wiki Inhalten ein eigenes Buch zusammenstellen können. Dieses Buch kann die Memory-Map Seiten und auch andere Artikel beinhalten. Jeder Artikel wird eine Sprach-Kennzeichnung haben, so das man nach nur deutschen Artikeln suchen kann.

Zusammengestellte Bücher können im System dann abgespeichert werden und auch anderen Benutzern zum Download bereitgestellt werden.

Die Idee ist das verschiedenen Personen Ihre versionen der Bücher pflegen können. Florian könnte ein Buch zu ACTION! Programmierung machen, ich eines zu Forth und Mirko zu Turbo Basic, und wir alle benutzen als Referenz die gleichen Memory-Map Artikel.

Das bisherige Wiki kann das noch nicht, aber das ist so ungefähr die Richtung wo ich hinkommen möchste mit dem AtariWiki.

Ciao

Carsten

von eda70 » Fr 8. Mai 2009, 16:50
8O
o-ha, das klingt gut. Also heißt es jetzt warten?

von cas » Fr 8. Mai 2009, 18:51
eda70 hat geschrieben:8O
o-ha, das klingt gut. Also heißt es jetzt warten?


Waren auf die Funktionen: ja

Warten mit dem Erfassen von Artikeln und Speicheradressen: nein. Alles was jetzt erfasst wird, wird auch später in dem neuen Wiki verfügbar sein.

Ciao

Carsten
1, 2