processing / processing/processing-website

Generate `.pdez` files for each code example

未关闭
#445 6 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

Examples Help Wanted
主要语言
MDX
星标
90
派生
122
平均合并
1 小时 43 分钟
30 天内合并 PR
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. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 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 摘要。