processing / processing/processing-website

Generate `.pdez` files for each code example

Offen
#445 6 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Examples Help Wanted
Vorherrschende Sprache
MDX
Sterne
90
Forks
122
Ø Merge
1 Std. 43 Min.
Gemergte PRs (30 T.)
3

Beschreibung

Context

As part of the effort to improve the Processing website and editor, a new feature has been introduced to allow users to open sketches and libraries directly in the Processing editor by clicking on a link. This will allow us to add a link to each example, opening the corresponding sketch directly in the Processing editor.

Problem statement

When browsing the examples page we want users to be able to run the examples in the Processing Development Environment (PDE). Currently, it can be time-consuming and confusing for users to manually copy and paste each tab of an example into the PDE and ensure that all required assets (e.g., images, fonts) are present.

The planned "Open in Processing Editor" feature aims to address this issue. However, it requires that each example have a .pdez file, which is not currently generated when running the script that copies examples over from the processing-examples repository.

Proposed solution

To address this issue, we can modify the existing updateExamples script that copies Processing code for each example from the processing-examples repository to the Processing website. Specifically, we can update the script to automatically generate .pdez files for each example and add them to the corresponding example folder in addition to the existing .pde files and any other files that are already being copied over.

Benefits

This change would greatly benefit users who want to quickly run examples from the website without having to manually copy and paste each tab into the PDE. By automating the process of generating .pdez files for each example, we can improve the user experience and make it easier for people to get started with Processing.

References

The process of updating examples on the website is described in details here:
https://github.com/processing/processing-website/blob/main/docs/examples.md

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit scripts/updateExamples.js und lies docs/examples.md, um zu verstehen, wie der Prozess zum Kopieren der Beispiele funktioniert. Verfolge, wie mit Beispielordnern und vorhandenen Dateien umgegangen wird, und überprüfe dann, dass jedes kopierte Beispiel neben seinen .pde-Dateien und anderen Assets eine .pdez-Datei erhält. Bestätige, dass die generierten Dateien die geplanten Links „Open in Processing Editor“ unterstützen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
tooling
Issue-Typ
Feature
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
38/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.