PythonScript icon indicating copy to clipboard operation
PythonScript copied to clipboard

Suggestion: improve structure of Doc

Open victorel-petrovich opened this issue 2 years ago • 0 comments

Changing from current structure (as seen in ToC)

  • Plugin Installation and Usage
    • Installation
    • Usage
    • Startup
  • Introduction
  • Objects
  • Npp Module
  • Working with Unicode Text
  • Handling Notifications
    • Overview
    • A simple example
    • Cancelling Callbacks
    • The Callback smallprint
  • Python Primer
    • Introduction
    • Basics
    • If Statements
    • Functions
    • Strings
    • Further Information
  • Notepad++ Object
  • Editor Object
    • Scintilla Methods
    • Helper Methods
  • Console Object
  • Enums
    • ...
  • Interface for Other Plugins
  • Compiling PythonScript
    • ...

To the new structure below:

  • Plugin Installation and Usage
    • Installation
    • Usage
    • Startup
  • A Python Primer
    • Introduction (or: overview)
    • Basics
    • If Statements
    • Functions
    • Strings
    • Further Information
  • PythonScript Overview (or: Introduction to PythonScript)
    • Intro (or: Foreword or: Overview etc)
    • Objects
    • Npp Module
    • Working with Unicode Text
    • Handling Notifications
      • Overview
      • A simple example
      • Cancelling Callbacks
      • The Callback smallprint
  • Notepad++ Object
  • Editor Object
    • Scintilla Methods
    • Helper Methods
  • Console Object
  • Enums
    • ...
  • Interface for Other Plugins
  • Compiling PythonScript
    • ...

Why move "Python Primer" before the above "PythonScript Overview "

  • Code examples in Python Primer (pythonprimer.rst) are much, much simpler than in Intro to PythonScript (as they contain very little PythonScript-specific detail). Especially than Handling notifications / callbacks.
    • In particular, it introduces functions that uses functions, which is used in "callbacks"
  • So it will help those who are new to Python; those who know it - will skip.
  • Once python-basics are behind, the topics will flow uninterrupted focusing on pythonscript-specific topics

victorel-petrovich avatar Jul 31 '23 03:07 victorel-petrovich