Design Pattern Page Creation

From Open Pattern Repository for Online Learning Systems
Jump to: navigation, search

These instructions first present general instructions or notes when creating any page. Then steps for the initial procedures to be done which is common in creating all kinds of pages are shown. Lastly, steps on creating particular kinds of pages are presented.

Account Creation

An account is required to contribute to the repository. Interested contributors can request an account, which will be approved by the repository administrator. You will receive an email notification when your account is created. You can then login to your account and start contributing to the repository.

General Notes

  1. Any text in a page that is in blue indicates a hyperlink with content that a user can click on to be directed to the appropriate page.
  2. Any text in a page that is in red indicates a hyperlink without any content yet. If a user clicks on it, it will redirect to “Create” page so a user can create the content for the link.
  3. To center text on page, use this script: <center> Text.</center>
  4. To create breaks using asterisks or arrows for OG or ALX formats, use this script: <center><nowiki>***</center></nowiki> OR
    <center><nowiki>▼</center></nowiki>
  5. To create numbered lists for a section, put a # sign and a space before each numbered item. For example:
    # Entry 1
    # Entry 2
  1. To create bullet points for a section, put * and a space after the asterisk before each item. For example:
    * Entry 1
    * Entry 2
  1. When mentioning a related pattern on a pattern page, use the script {{Patternlink|Pattern Name}} without any underscore for the spaces. This will provide a hyperlink to the related pattern on the page.
  2. For references mentioned in the page, use the script: <ref>APA citation</ref> or <ref name=”Author”>APA citation</ref>. Using the script
    <ref name=”Author”></ref> will allow you to refer to the same reference later on in the same page by just using the script:
    <ref name=”Author”/> instead of having to retype the entire reference again.
  3. If there are links to articles available (used as source or reference), you can include the link in the APA citation itself by typing in [http://url_of_article Article Title] as the Article Title. The first part of this script denotes the url of the link, then a space is placed in between the URL and the actual title of the article.


To Include Images to a Page

  1. To include images to a page, first upload the image file to the repository. Click on the “Upload File” link at the left sidebar of the main page.
  2. On the Upload File page, click on “Choose File” button. A dialog box will open, locate the image file you want, then select “Open”.
  3. In the File Description box, under the heading “Destination Filename”, check that it is the correct filename of the image you want. Make sure the spaces are represented with an underscore. Slashes or special characters on the filename usually needs to be changed or corrected to avoid errors (you can use dashes or underscores instead).
  4. In the Summary section, type in a short description of your image. Then click on “Upload File” button at the bottom of the page.
  5. Script to include images in a pattern page is [[File:Image Name.png|center|800px]] (You can adjust the size of the image by reducing or increasing the pixel-e.g., 400px instead of 800px)


Creating A Page

  1. Type in URL: “https://www.learningenvironmentslab.org/openpatternrepository/Title_of_Page” (this is for OPR format, for other formats see Notes below) and press enter. You will be redirected to a page indicating that there is currently no text on the page so you can create it.
    Title page.png

    Notes:

    • Spaces in the title name need to be represented with underscore marks ( _ ).
    • Capitalize main words of title name.
    • Avoid putting periods at the end of the title name (e.g., Title…) as this will cause errors in creating the page and difficulties in trying to delete the page itself
    • To create page in original format (OG), type in URL as: “https://www.learningenvironmentslab.org/openpatternrepository/Title_of_Page/OG”
    • To create page in Alexandrian format (ALX), type in URL as: “https://www.learningenvironmentslab.org/openpatternrepository/Title_of_Page/ALX”
  2. Click on “Create” at the upper righthand area of the page. The page will now show “Creating Title_of_Page”.
Creating page.png


To Create Author Page

  1. After doing steps in Creating A Page above, click on the arrows under “Select boilerplate” and select “Author Page”. Click “Load”. The text area will autofill.
  2. Under Summary area, type in “Created author page”.
Author page.png
  1. Click on “Show Preview” to see and check/edit your work if needed.
  2. If everything looks okay, click on “Save Page”.
Author preview page.png


To Create Alias Page (Link Only)

  1. After doing steps in Creating A Page above, do not load any selections under “Select boilerplate”.
  2. Go directly to text area and type in “See {{Patternlink|Original Pattern Name}}. Include other names that the pattern may have using the script {{Patternlink|Other Name 1}}
  3. Then below this, type in “[[Category:Design_patterns]] [[Category:Alias]]<!-- List of other categories the design pattern belongs to. The syntax for linking to a category is: [[Category:<Name of category]] --> “ (or you can also copy and paste this portion from another alias page).
  4. Under Summary area, type in “Created alias page”.
Alias page.png
  1. Click on “Show Preview” to see and check/edit your work if needed.
  2. If everything looks okay, click on “Save Page”.
Alias preview page.png


To Create Patlet or Pattern Page

  1. After doing steps in Creating A Page above, click on the arrows under “Select boilerplate” and select “Design Pattern”. Click “Load”. The text area will autofill.
  2. For “Contributor” in the Infobox area, list the main authors of the pattern. Use the script [[First Name Last Name 1]], [[First Name Last Name 2]] and so on for each name to create links for author pages of these authors. See area in red box in image below.
  3. For “Source” in the infobox area, type in the last names of all authors (if more than 3, you can use “Last Name et al.” instead) and the year of publication in parentheses. Then use script <ref>APA citation</ref> or <ref name=”Author”>APA citation</ref>. Using the script
    <ref name=”Author”></ref> will allow you to refer to the same reference later on in the same page by just using the script <ref name=”Author”/> instead of having to retype the entire reference again.

Note: When needed (pattern was mentioned or published in many different sources), try to be particular when the source published the patlet and the pattern. (e.g., “First mentioned in…[APA]”, “Patlet published in…[APA]”, “Pattern published in…[APA]”, “Also mentioned in…[APA]”, etc.). This can be written under “Source” as: Last Name 1 & Last Name 2 (year) <ref>Pattern published in Last Name 1, A. & Last Name 2, A. (year)....</ref> so that the particulars will only appear under the References section and not under the Infobox area.

For Patlet

  1. On the main content section, type in the patlet (or copy and paste patlet) in the Patlet area. See area with green box in image below.
  2. Leave other fields blank. You can include related patterns under “Related Patterns” section if there are any.
  3. On bottom portion of the main content area, beside the text “[[Category:Design_patterns]]”, type in [[Category:Patlet]] [[Category:Pattern Language]]
  4. Under Summary area, type in “Created patlet for pattern”.
Patlet page.png
  1. Click on “Show Preview” to see and check/edit your work if needed.
  2. If everything looks okay, click on “Save Page”.
Patlet preview page.png

For Pattern in OPR Format

  1. Type in or copy and paste the content from the source under each appropriate heading/section. (Put patlet or summary of the pattern into Patlet section, text for context under “Context” heading, examples for the pattern under the “Examples” heading, etc.)
  2. On bottom portion of the main content area, beside the text “[[Category:Design_patterns]]”, type in [[Category:Full Pattern]] [[Category:Pattern Language]]
  3. Under Summary area, type in “Created pattern in OPR format”.
OPR pattern.png
  1. Click on “Show Preview” to see and check/edit your work if needed.
  2. If everything looks okay, click on “Save Page”.
OPR preview.png

For Pattern in Original Format (OG)

  1. Highlight main content area from Patlet section to Example section and delete. This will leave the Infobox area, References section and Category section on the page.
  2. Copy and paste the pattern from source as is (in original format) into the main content area. This is the space BELOW the Infobox area and ABOVE the References section.
  3. On bottom portion of the main content area, beside the text “[[Category:Design_patterns]]”, type in [[Category:Full Pattern]] [[Category:Pattern Language]]
  4. Under Summary area, type in “Created pattern in original format”.
OG pattern.png
  1. Click on “Show Preview” to see and check/edit your work if needed.
  2. If everything looks okay, click on “Save Page”.
OG preview.png

For Pattern in Alexandrian Format (ALX)

  1. Highlight main content area from Patlet section to Example section and delete. This will leave the Infobox area, References section and Category section on the page.
  2. Copy and paste the pattern from source in Alexandrian format into the main content area. This is the space BELOW the Infobox area and ABOVE the References section.
  3. On bottom portion of the main content area, beside the text “[[Category:Design_patterns]]”, type in [[Category:Full Pattern]] [[Category:Pattern Language]]
  4. Under Summary area, type in “Created pattern in Alexandrian format”.
ALX pattern.png
  1. Click on “Show Preview” to see and check/edit your work if needed.
  2. If everything looks okay, click on “Save Page”.
ALX Preview.png