PegaWiki help internal

From PegaWiki
(Redirected from PegaWiki help internal)

This is the approved revision of this page, as well as being the most recent.
Jump to navigation Jump to search

Learn how you can add design patterns to PegaWiki by using the visual editor or by creating a draft in Microsoft Word.

All curators will have reviewed and will utilize the current curation guidelines. To review these guidelines, click here.

Adding and editing a design pattern in the visual editor

Create your design pattern by using the intuitive built-in visual editor in PegaWiki.

  1. Log in to PegaWiki.
  2. In the navigation panel on the left, in the Contribute section, click Create new request.
  3. On the Create new request page, in the text field, enter the title of your design pattern, and then click Check.
  4. In the list of related design patterns, verify if the article that you want to create does not exist already.
  5. On the confirmation page, click Create.
  6. In the article template, provide a design pattern description, include the version as of, application, and capability/industry.
  7. In the visual editor for your draft article, edit your content by using the default template.
  8. When your content is ready for publishing, on the top of the article template, in the Request to Publish field, enter Yes.
  9. After making your edits, save your content:
    1. Click Save page.
    2. In the Save your changes dialog box, add a summary comment that briefly describes your work, and then click Save page.

Note: The design pattern will be published after it is reviewed by a curator. The curation process takes approximately 48 hours.

Creating a design pattern from a Microsoft Word draft

If you have a draft design pattern ready in your database, you can copy and paste the content to PegaWiki.

  1. Log in to PegaWiki.
  2. In the navigation panel on the left, in the Contribute section, click Create new request.
  3. On the Create new request page, in the text field, enter the title of your design pattern, and then click Check.
  4. In the list of related design patterns, verify if the article that you want to create does not exist already.
  5. On the confirmation page, click Create.
  6. In the article template, provide a design pattern description, include the version as of, application, and capability/industry.
  7. In the visual editor for your draft article, paste the design pattern content in the indicated location, and make formatting adjustments as needed.
  8. When your content is ready for publishing, on the top of the article template, in the Request to Publish field, enter Yes.
  9. After making your edits, save your content:
    1. Click Save page.
    2. In the Save your changes dialog box, add a summary comment that briefly describes your work, and then click Save page.

Note: The design pattern will be published after it is reviewed by a curator. The curation process takes approximately 48 hours.

Tips for editing design patterns

To efficiently add your design patters to PegaWiki apply the following best practices.

Formatting

Keep your formatting consistent and simple:

  • Use the formatting capabilities in PegaWiki visual editor to fine-tune your content.
  • Avoid multiple levels of nesting bullets or numbers.
  • Do not use Roman numerals unless you want to describe a set of steps for users.

Headings

Level 2 headings automatically create a table of contents.

Adding images

Use images in your design patterns to make your content easier to follow and more engaging. If you create your design pattern in Microsoft Word, prepare your image files.

  1. Make placeholders for your images in the document.
  2. Save every image separately as a .png or .jpeg file.
  3. Paste your draft document into PegaWiki.
  4. In your PegaWiki draft, click in the place where you want to insert your image.
  5. In the visual editor header, on the Insert menu, click Media.
    Inserting media
  6. In the Media settings dialog box, select your files:
    1. If your files are in the PegaWiki database, on the Search tab, enter your image title, and then select the image file.
    2. If your files are on your local drive, on the Upload tab, click Select a file, search for your file, select the This is my own work check box, and then click Upload.
  7. To edit the image, click the image thumbnail, and then click Edit.
  8. In the Media settings, enter the image caption, make your other changes, and then click Apply changes. Captions will only appear on image types of thumbnail or frameless.

Customizing how a screen shot appears

After you insert a screen shot, you may want to modify how it appears.

  1. Click the screen shot on the design pattern article, and then click Edit.
  2. Click the General settings tab to modify the caption and set the alternative text.
  3. Click the Advanced settings tab to modify the following settings:
Setting Description
Position Specify where the screen shot appears within the text column. In most cases, click Left to align the screen shot to the left margin.

You can also choose to wrap the text around the screen shot.

Image type Choose from Thumbnail, Frameless, Frame, or Basic.

In most cases, choose Basic.

Image size Specify a custom size for the screen shot, or just click Make full size.

4. Inspect the result and customize more if needed. Click Apply changes when finished.

Adding links

Use links to provide the user with references to related resources. You can also point the user to a different place in the document.

  1. In your PegaWiki design pattern, select the word or phrase from which you want link to another resource.
  2. In the visual editor header, click the Link icon.
    Link icon
  3. In the Link dialog box, configure your hyperlink:
    • To link to another PegaWiki page, on the Search pages tab, enter the name of the page to which you want to link, select the target page title, and then click Insert.
    • To link to an external page, on the Search pages tab, enter the URL of the target page to which you want to link, and then click Insert.

Prohibited Content

Review and follow these guidelines to ensure that Pega Community Wiki is a healthy, vibrant community.

Pega Community Wiki content should not include:

  • Personal content
  • Customer references
  • Customer names
  • Competitor references
  • Competitor names
  • Company confidential information
  • Commentary or subjective opinion on products of other vendors or the vendors themselves
  • Quotes containing commentary or subjective opinion on products of other vendors or the vendors themselves
  • Derogatory language
  • For a complete list of Prohibited content please see the Terms of Use.

All curators should be familiar with Pega's privacy notice and terms of use available on Pega.com

Questions and or concerns regarding privacy please contact us.

Need support or have questions?

Contact us.

Additional resources

To discover the current technical documentation for Pega products, explore the course offering, or learn the style guidelines, see the following resources:

Useful resources
Page URL Description
Pega Community https://community.pega.com/ Discover our vast portfolio of detailed feature descriptions, step-by-step procedures, interactive tutorials, and implementation guides for Pega products.
Pega Academy https://academy.pega.com/ Explore our growing list of missions, add one to your dashboard, and start learning exactly what you need, when you need it. Earn industry-recognized Pega certifications to demonstrate your commitment to excellence while keeping you in-demand.
Pega Collaboration Center https://collaborate.pega.com/ Build working relationships, ask questions, share unique experiences, and solve problems with the experts
Style Guide for content contributors https://community.pega.com/knowledgebase/articles/style-guide-content-contributors/other/style-guide-content-contributors Learn how to create quality technical documentation.