Help the wiki!

The Scratch Wiki is made by and for Scratchers. Do you want to contribute?

Learn more about joining as an editor!

See discussions in the Community Portal

Project Notes

An example of Project Notes.

The Project Notes feature is a way for Scratchers to type documentation that goes with their projects for other Scratchers to see and understand what the project is about. They are separated into two sections, the "Instructions," and the "Notes and Credits." Only the sharer of a project or member of the Scratch Team can edit the project notes. This is to avoid false information and to ease the project's owner. Project notes can be found on the right of a shared project's page.

Contents

Sections

There are two sections to the project notes.

Project Instructions

Project Instructions is a place where one can put instructions to their game, such as keys to press. It can also be used as a strategy guide of some sort.

Notes and Credits

Notes and Credits allows Scratchers to explain some facts about how they made their project (such as how long it took them and where they got the idea) and to give credit where it is needed. It is also used to add side notes on a project, advertisements and the version number. This is the only section shown if the project was created before Scratch 2.0.

Editing

Project notes can only be typed online at the moment.

Online

Online editing can only be done one way: Clicking the project notes area on a project's page. A text box appears, and text can be inserted. However, many users have complained of the small space to write their text in—some instead type in a word processor and paste the text.[1]

Links

If you give a link to a project, forum thread/post, studio, or wiki article in some project notes, it comes up as a link which says (link to project), (link to forums), (link to studio), or (link to wiki) respectfully. This makes it easier to make sense of links in the project notes. This can also be used with usernames, so @user will become a link. This can also be done in comments.

Studio Notes

Studio Notes are the same as project notes, except they contain information about a studio rather than a project.

Common Uses

Project notes are generally used for explaining information about their project. Some examples of uses are:

  • Explaining how to use the project
  • Saying what the project is about
  • Showing the current version number of the project
  • Announcing how long the project took to make
  • Explaining what the project does
  • Giving credit to people who may have helped with the project
  • Saying how the project was made, providing extra information and documentation, and links for further reading

However, Project Notes are also used in other ways, such as:

  • Giving information about the user who shared the project
  • Asking people to view other projects of the user
  • Telling people that a download is necessary
  • Telling people what projects the creator of the project is currently working on

There are also other multiple ways the Project Notes are used for, but there are too many to list all of them here.

Changing the Default Project Notes

By default, the Project Notes in a Scratch project are blank. If you want to provide questions or instructions whenever users first edit a project’s notes, you can create a default Project Notes file. Simply make a text file with your default notes, save it with UTF8 encoding, name it "defaultNotes.txt", and put it into the Scratch folder.

History

Editing the project notes before uploading in the Scratch 1.4 offline editor.

In Scratch 1.x there was only one section called "Project notes." It could be edited when you uploaded a project from the editor as well as online.

See Also

References

  1. http://scratch.mit.edu/forums/viewtopic.php?id=115458
  • This page was last modified on 11 February 2014, at 04:18.