Diskussionen und Krempel (alt: Verbesserungen Doku v4)

[MVXA]

System hieß zuerst auch Fenster. Dann kam ich aber zur Lib "Process" und
wusste nicht so recht wo hin damit. Dann hab ich die Kategorie System
genannt und die Lib da rein geschoben.

Ich bin auf jedenfall für eine Kategorisierung der einzelnen libs, da es in
der letzen Zeit einfach immer mehr werden und so langsam die Übersicht
verloren geht.

[masel]

falls die noch nicht genannt und/oder inzwischen gefixt sind:

PureBasic.chm::/file/writestringformat.html

"Die #PB_Ascii #PB_UTF8" und #PB_Unicode entsprechen"

Das "#PB_UTF8" nicht eingefärbt wie die anderen, ich denke da ist nur ein Zeichen oder sowas verkehrt.

PureBasic.chm::/file/fileseek.html

"Syntax

FileSeek(NeuePosition)"

Ich da muss glaub noch ein zweiter Parameter, wie in dem angegebenen Beispiel hin:

FileSeek(#Datei, NeuePosition)

[Konne]

Bei "Zahlen" steht unten </body></html>

[ullmann]

@Andre, @MVXA

Ich finde es sinnvoll, wenn die Hilfe weiter gegliedert wird. Allerdings gefällt mir der Vorschlag von MVXA nicht so gut.

2D Spiele, 3D Spiele: PB ist doch ein allgemeines Programmierwerkzeug, da würde ich nicht definitiv auf "Spiele" nennen. Bis auf Sprites, die wirklich nur für Spiele sind, können die anderen Sachen auch für Anwendungen, Tools, Simulationen etc. verwendet werden.

Eine Kategorie "Sonstiges" zeugt davon, dass man sich nicht genug Gedanken über eine Zuordnung gemacht hat. Es gibt keine Sache, die man sofort als erstes bei "Sonstiges" suchen würde.

Das bezieht sich sinngemäß auch auf die bisherigen Gruppierungen "Allgemeine Themen" und "Verschiedene Themen" und "Misc". Das sagt nichts aus.

Die Library Misc könnte wie folgt aufgelöst werden: Red(), Green(), Blue(), RGB() kommen zu Palette, neuer Name: Color. Delay() und ElapsedMilliseconds() kommen zu Date, neuer Name: Date & Time. Random() und RandomSeed() passen aufgrund der Nähe zu Wahrscheinlichkeiten in Math. GetExtensionPart(), GetFilePart(), GetPathPart() passen in File (auch wenn sie keinen Dateizugriff erfordern, passen sie aber logisch). OSVersion() passt in Process, ist ähnlich wie Environment im entfernten Sinne ein "Umgebung".

Ich habe nachfolgend einen konkreten Vorschlag, wie ich die Hilfe gliedern würde. Da das Auflösen von Misc nichts mit der Gestaltung der Hilfe zu tun hat, habe ich Misc verwendet.

Code: Alles auswählen

				PureBasic

Einleitung
    Überblick + Eigenschaften
    Rechtliches
    Systemvoraussetzungen
    Bestellen
    Installation
    Verwendung mehrerer PureBasic-Versionen
    Kontakt
    Danksagungen
    Geschichte

Komponenten
    IDE, Compiler, Debugger, Hilfe
    Visual Designer
    Shell Compiler

Grundlagen
    Syntax
    Konstanten
        einfache Konstanten
        nummerierte Konstanten // Enumeration : EndEnumeration
        Datenblöcke // DataSection : EndDataSection, Restore, Data, Read
        vordefinierte Konstanten // #PB_...

    Variablen, Typen, Operatoren
        Definition // Define 
        einfache Variablen, Basistypen, Operatoren
        Tabellen (Felder, Arrays) // Dim, ReDim
        Listen // NewList
        Strukturen // Structure : EndStructure, StructureUnion, With : EndWith
        Gültigkeit von Variablen // Global, Protected, Shared, Static
        Werteaustausch // Swap

    Zeiger und Adressen
        Adressen
        Zeiger auf Labels
        Zeiger auf Variablen
        Zeiger auf Speicherbereiche
        Zeiger auf Funktionen

    Objekte, Handles, Zugriff auf externe Elemente
        PureBasic-Objekte // #PB_Any
        Handles und Nummern
        Objektorientierte Elemente // Interface : EndInterface
        Externe Daten-Typen (Pseudotypen)
        Externe Funktions-Typen // Prototype
        Externe Funktionen und Variablen // Import : EndImport

    Windows - Ereignisverarbeitung (Message Handling)

Compiler-, Debugger-, Quelltext-Steuerungen
    Compilersteuerung
        Compilerdirektiven
        Compilerfunktionen
        Subsysteme
        DLL-Erstellung
        Unicode

    Debuggersteuerung
    Quelltextsteuerung
        Makros // Macro : EndMacro
        Include - Funktionen
        Inline X86 - Assembler

Steuerung des Programmlaufes
    Marken, Sprünge, Ende
        Marke (Label)
        Sprung // Goto
        Ende // End

    Bedingungen, Auswahl
        Bedingung // If : ElseIf : EndIf
        Auswahl // Select : Case : EndSelect

    Schleifen
        mit Zähler // For : To : Step : Next
        für Listenelemente // ForEach : Next
        mit Kopfbedingung // While : Wend
        mit Fußbedingung // Repeat : Until, Forever
        nächster Durchlauf // Continue
        Abbruch // Break

    Unterprogramme, Prozeduren
        Unterprogramme // Gosub : Return
        Prozeduren // Procedure : EndProcedure

3D - System
    Billboard
    Camera
    Engine 3D
    Light
    Material
    Mesh
    Particle
    Terrain
    Texture

Ausgabe und Gestaltung
    2D Drawing
    Console
    Font
    Palette
    Printer
    Sprite + Screen
    Sprite 3D

Bedienoberfäche
    Gadgets
    Help
    Menu
    Requester
    Statusbar
    Systray
    Toolbar
    Window

Betriebssystem
    Clipboard
    Date
    Desktop
    File
    Filesystem

Datenverarbeitung
    Cipher
    Database
    Linked List
    Math
    Packer
    Sort
    String

Eingabegeräte
    Joystick
    Keyboard
    Mouse

Medien
    Audio CD
    Image
    ImagePlugin
    Module
    Movie
    Sound
    SoundPlugin

Programmierung
    Library
    Memory
    Misc
    Network
    On Error
    Preference
    Process
    Thread

Anhang
    Zahlensysteme / Tabelle
    ASCII Codes mit Zeichen
    Mathematische Formeln
    Farbtabelle
    Port-Nummern für Internet
    Nützliche Internet-Links über PureBasic

Ich hatte das alles eingerückt, farbig und mit Aufzählung als WordPad-RTF Dokument und konnte das hier über die Zwischenablage nicht einfügen und musste so alles neu einrücken und anstelle Farben die // zum Abgrenzen verwenden. Wie hätte ich das Dokument hier einfügen können (ohne URL) ?

Rainer

[Andre]

@masel / Konne: danke für die Hinweise => fixed.

@ullmann:
Dieser weiter ausgearbeitete Vorschlag nach der Idee von 'MXVA' mit der Untergliederung gefällt mir schon langsam so gut, dass er für eine Umsetzung in Frage kommt. Ich bin aber auch hier wirklich an weiteren Meinungen dazu interessiert.

Was die direkte Zuordnung der Befehle zu anderen Libraries angeht, dafür ist ja Fred zuständig. Er kennt aber auch schon diese Problematik - werde ihn nochmal auf diese neuesten Vorschläge hinweisen.

Das Einfügen von .doc Dateiinhalten ins Forum wirst Du wohl nicht ohne weiteres hinbekommen. Da ist schon ein Link auf die Datei zum Downloaden notwendig. Kannst mir diese aber auch gerne mal per Mail zusenden. Danke!

[MVXA]

@ullmann
Nunja, wenn ich ehrlich sein soll, dein Vorschlag gefällt mir auch eher
weniger. Zuerst war ich von deinen Ideen im oberen Teil deines Posts
überzeugt, aber als ich die Zuordnung gesehen habe, sah ich, dass du
deine eigenen Vorschläge kaum oder garnicht verwirklicht hast.

Ich werde dann meinen Vorschlag für die Gruppierung auch noch mal
ändern. Beim Schlaf sind mir auch ein paar neue Idee gekommen.

@Andre
> 'MXVA'
wenn dir mein Nick nicht gefällt, kannst du mich auch Arthur nennen .

[ullmann]

@Andre
Gern geschehen.
Gruß Rainer

@MVXA
Mich hat schon immer gestört, dass es eine Library "Misc" gab (Random suchte ich zuerst in Math und musste vieles durchklicken um es zu finden) und dass der GOTO-Befehl, in "Andere Befehle" stand. Obwohl er nicht verwendet werden sollte, sollte er nicht dahin verbannt werden.
Dein Vorschlag gab mir dann den Anstoß, über die Gliederung gründlich nachzudenken. Sowohl die Gliederung des ersten Teiles als auch die Zuordnung der Libraries basierte auf eigenen Überlegungen und unter dem Aspekt, dass Andre möglichst seine fertigen Seiten nicht umbauen muss (z.B. verstehe ich Structure nicht als Variable, sondern als Typ und ich hätte Typen wie auch Operatoren komplett von Variablen getrennt). Sicher gibt es Gemeinsamkeiten mit deinem Vorschlag, denn 3D ist numal 3D und Bedienelemente, z.B. Gadgets gehören nunmal auch zusammen. Meine genannten Kritiken habe ich in meinem Vorschlag umgesetzt. Lediglich Misc kann Andre mit der Hilfe nicht auflösen, so dass Misc solange es existiert in der Hilfe drin bleiben muss.

Gruß Rainer

[Andre]

@MVXA: das kommt davon, wenn man solche schwierigen Nicks auswendig eintippen will.
In Zukunft also Arthur

Ja, und wie gesagt, zu der Untergliederung der Libraries wäre ich natürlich noch an Meinungen weiterer User interessiert. Werde das auf jeden Fall nicht so überstürzt von jetzt auf dann mit dem erstbesten Vorschlag integrieren.

Ihr könnt Euch ja auch mal die Übersicht der PB-Befehle in der PureWiki anschauen, wo auch eine Untergliederung vorgenommen wurde:
http://www.purearea.net/pb/english/pure ... s_overview

[ullmann]

@Andre:
Ruft man den Befehlsindex auf, so dauert es schon recht lange, bis man zu den letzten Buchstaben (ganz unten) gescrollt hat. Wünschenswert wäre im Befehlsindex ganz oben ein Alphabet, wo man jeden Buchstaben anklicken kann und man damit gleich an die entsprechende Stelle kommt.

Rainer

[kajott]

Folgendes:

habe ein String-Array mit Dim text.s (0) erstellt.
In der Hilfe steht Redim text (1000).

Muss aber heissen Redim text.s (1000)