processing / processing/processing-website

Generate `.pdez` files for each code example

オープン
#445 コメント 6 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

Examples Help Wanted
主要言語
MDX
スター
90
フォーク
122
平均マージ
1時間 43分
マージ済み PR(30日)
3

説明

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

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

scripts/updateExamples.js から始め、docs/examples.md を読んで、サンプルをコピーするプロセスがどのように機能するかを確認してください。サンプルフォルダーと既存ファイルの扱いを追跡し、その後、コピーされた各サンプルに .pde ファイルやその他のアセットと並んで .pdez ファイルが生成されることを確認してください。生成されたファイルが、計画されている「Open in Processing Editor」リンクに対応していることを確認してください。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
javascript
領域
tooling
issue の種類
機能追加
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
38/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。