Conventions to follow to maintain a consistent look-and-feel and manage the security.

Before Creating a Page

  1. Do a search to see if a similar information exists -- duplicate pages promote confusion and inconsistencies.
  2. Update a page with extra information rather than creating a new page with similar data

Page Name

  1. Clarity, and specific page names (rather than general ‘Zynq’ for example) help during searches to keep the search results as relevant as possible.
  2. The Page Name gets reflected in the page’s URL. A page named ‘Zynq Application Notes’ would have a corresponding URL of wiki.xilinx.com/Zynq+Application+Notes
  3. The Page Name automatically becomes the page Title ! Do not add a title on your page. The Page Name (and therefore, Title) for Zynq Tech Tips should follow the format:
Zynq-7000 AP SoC [remainder of title goes here] Tech Tip . {Note that file attachment names should not contain special characters such as "&" etc; only alphanumeric characters may be used}

Redirect

  1. Use Re-directs if you need to navigate users from an obsolete page to a different page

Template

  1. A common look and feel is desirable across the pages.
  2. The default template is the Xilinx Template. Use that, unless you are specifically creating a TRD or a TechTip. For Tech Tips, use the Tech Tips Template.
  3. By default, the template contains the Table of Contents which you should keep for easy navigation on long pages.

Creating a New Page

To create a new page:
  • Click on the "+" sign next to "Pages and Files" on the side menu
  • Type the name of the page in the 'Page Name' field
newpage.JPG
  • Select the appropriate template from the 'Use a Template' dropdown, and Create.
new-page-template.jpg

Editing a Page

Click on the "Edit" button on the top right-hand corner of the page to switch into Edit mode.
The default editor is a WYSIWYG or Visual Editor. You can also edit your page in Wikitext directly. To do this, you must first be in Edit mode. Click on the Pulldown menu next to 'Save' and select 'Wikitext Editor' .
A list of Wikitext commands is here . Some formatting, such as indents, adding cross-references etc, are easier done in the Wikitext editor.

Uploading Files

You are ultimately responsible for files that you upload. The following applies to every file that you upload:
By uploading this file you certify that making the file available does not violate any copyrights and that it contains no content that violates Copyright or US export laws .

The file that you upload must follow standard Xilinx Compliance rules.
Files containing information that may be distributed only under terms of license agreement, must go through a secure/registered flow. In this flow, a user would sign in and accept the license terms, before being able to access material.

File names may contain only alphanumeric characters and _ . Special characters such as "&" are not permitted.

Tags

Important! Tag every page appropriately. This will ensure that the page is easily found, and will enable the page to make it to lists of particularly tagged pages. Xilinx Application Notes (XAPPs) only, must be tagged 'appnote' .
Type
Tag
Tech Tip
techtip
TRDs
TRD
XAPP
appnote

External and Internal Links

Links to external sites should open in a new window or tab.
Links to internal wiki pages, should open in the same window.

Creating Discussion Groups

1. Create a blank new page
2. Add the text "New Post" on the first line of the page
3. Click on 'Widget', and select "Discussion Area"
-This will insert a discussion group area on the page
4. Save the page
5. Navigate to the actual discussion area by clicking on the chat bubble in the upper right corner of the page.
6. Right click the "New Post" button and copy the URL
7. Navigate back to the page and click the Edit button.
8. Then use the Link tool (Web Address) and paste in this address. This gives your users a link to create a new post without having to navigate to the actual discussion area.
9. Save
The permissions on this page should already be set to 'everyone' , by default.