Wolfram Language Example Repository
Ready-to-use examples of the Wolfram Language
What to Submit
What to Submit
◼
Examples should be understandable by someone familiar with the domain, but not necessarily with Wolfram Language
◼
Examples should not explain or define something the audience should already know
◼
E.g. if the example is about how to solve the heat equation, it doesn’t need to explain what the heat equation is
See examples
◼
Example length
◼
One line of code is too short
◼
Three pages is usually too long
Notebook Sections
Notebook Sections
Example Name
Example Name
◼
Example names should be as specific as possible to reflect the content and avoid overlap with other titles
See examples
◼
Example names should be relatively short
◼
Example Names Should Be in Title Case
◼
Capitalize the first, last and all major words (pronouns, adjectives, adverbs, verbs and nouns)
◼
Prepositions, articles and coordinating conjunctions are lowercase unless they are the first or last word or function as a particle; the "to" in infinitives is also lowercase
◼
Capitalize the first word of a subhead after a colon or em dash
See examples
One-Line Description
One-Line Description
◼
The text below the name should be a brief, stand-alone, plain text description of the example without ending punctuation
◼
The description should begin with an imperative verb
◼
The description adds context and detail to the title
See examples
◼
The description can be left blank if the title is self-explanatory
Example Content
Example Content
◼
Examples are a sequence of inputs and outputs with short code captions
◼
An introductory paragraph should not be needed
◼
If one is used, it should be short
◼
Consider breaking up the text and adding it to the part of the example where it is relevant
◼
Code captions should use the CodeText style (found under Format ▶ Style ▶ CodeText)
◼
The code caption doesn't need to explain the syntax of the function but can link to documentation; it should explain what the code does
See examples
◼
Code should be reasonably efficient and readable
◼
Options and other long lists can be iconized
◼
Consider splitting up big blocks of code
◼
Examples can have subsections; the first section should be a single stream of thought
◼
Separate ideas should be contained in their own section
◼
It’s ok to end with a conclusion section of text
◼
Check that examples run on desktop
◼
Examples don't need to run in the cloud (but they will be displayed in an embedded cloud notebook)
◼
Examples can require a specific paclet
◼
Include the code to install the paclet
Supporting Data and Definitions
Supporting Data and Definitions
◼
◼
Use the Insert ResourceObject button along with ResourceData to reference the data associated with the example
Thumbnail Image
Thumbnail Image
◼
The thumbnail image will appear at the top of the example page
◼
It should be an output from the Wolfram System showing results of the example
◼
It should be 500x500 pixels square
◼
The thumbnail image is optional
Source & Additional Information
Source & Additional Information
Keywords
Keywords
◼
List relevant terms that should be used to include the example in search results
Categories
Categories
◼
Choose as many relevant categories as needed
◼
Custom categories will be reviewed before being accepted as new categories in the repository
Related Documentation Pages
Related Documentation Pages
◼
Include the functions used in the example
◼
Include other closely related functions
◼
Entities and functions in paclets cannot be linked by name here but can be added under the Links section
Related Resource Objects
Related Resource Objects
◼
Include related examples, functions, paclets, etc. from any Wolfram repository
Original Source References and Attributions
Original Source References and Attributions
◼
Use this section to cite or otherwise give credit to other sites, papers or code repositories relevant to the creation of the example
Links
Links
◼
Other relevant external links can be added here
◼
Link to entities and paclets go here
Author Notes
Author Notes
◼
Use of this section is optional
◼
Content displayed in this section can include background, possible improvements, additional information, implementation details and/or version release notes that are otherwise beyond the scope of the example documentation