Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suggestion: improve structure of Doc #297

Open
victorel-petrovich opened this issue Jul 31, 2023 · 0 comments
Open

Suggestion: improve structure of Doc #297

victorel-petrovich opened this issue Jul 31, 2023 · 0 comments
Labels

Comments

@victorel-petrovich
Copy link

victorel-petrovich commented Jul 31, 2023

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
@chcg chcg added the Docu label Jan 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants