Adding Portal Content and Navigation

Use the Content tools to create and modify the content of your Portal, and to moderate and maintain the content after the initial launch.

Before Adding Content

There are three important considerations when you are adding content:

  • Document Location. The Document Location defines the directory structure of the content you are creating. The directory structure then defines the navigation for the content. For example, all Wiki document paths start with the root directory of /wiki. If you enter /tips, the document you are creating will be located in the directory /wiki/tips and be a child of the document in the root directory /wiki. Documents in the /wiki/tips directory will appear as children of the /wiki directory in the Wiki navigation. Because of this link between document location and navigation, it's worth the time to plan out how you want your wiki pages to be structured before you start entering content into the Dashboard.

  • Tags. Each content type provides a place for you to enter tags. These tags are then used to define categories throughout the Portal. Anywhere there is a link for a category, all content that includes the matching tag is displayed. Because of this matching, it's important that you think through the tags you are going to use. The matching must be exact. For example, a link to the tag "installation" will not find content tagged with "installing". Tags are also case-sensitive (Installation/installation) and number-sensitive (file/files). Use multiple tags by separating them with a space.

  • Content Types. The main difference between the content areas are their features and their level of interactivity. For each type of content, determine which "medium" is appropriate.

Wiki Docs Custom Pages Blog Forum Topic
Summary *
Path (filename) * * *
Title/Topic * * * * * *
Body/Full Entry * * * * * *
Tags * * * * * *
Change Summary * * *
Order * * *
Status * * * * * *
Sidebar *
Custom CSS *
Comments * *
Moderation *

Wiki

The Wiki is a place where both you and your developers can post content pages. The Wiki uses Markdown, a lightweight markup language. If you are unfamiliar with Markdown syntax, Mashery provides a tips area that explains what you need to know. Using Moderations Settings, you can allow registered users to modify pages or comment on pages that appear under the main content.

To create a page for your Wiki from the Dashboard, enter the following information:

  • Document Path - The location of your Wiki page. Document Path is very important to the navigation of your Wiki, so plan your structure carefully. Links to Wiki pages are created by linking to your document path. For more information see Adding Content.

  • Title - The title of your Wiki page. This will appear in the title bar, as the title of the page, in the navigation and in the Dashboard.

  • Body - The main text of your Wiki page. Wiki pages use Markdown to format the page. If you are unfamiliar with the Markdown syntax, click the tips link for an explanation. A link to Markdown tips is available at the top of the text box. To increase the height of the text box, use the dropdown list above to select a different height.

  • Tags - Categories for your Wiki page. Be sure to read the information on planning your tags in Adding Content.

  • Change Summary -A listing of changes to the Wiki page, which is a helpful tool in scanning through past revisions.

  • Order - The order of the Wiki page in relation to its siblings in the Wiki navigation.

Docs

The Docs area consists of pages formatted in either HTML or Markdown so you can post documentation for your API or Web Service. The navigation of the Docs area is determined by the directory structure you use in creating your documentation pages. Developer comments appear below the documentation text and comments can be set to require moderation.

To create a page for your Docs area, enter the following information:

  • Document Path - The location of your Docs page. Document Path is very important to the navigation of your documentation, so plan your structure carefully. Links to Docs pages are created by linking to your document path. For more information see Adding Content.

  • Title - The title of your Docs page. This will appear in the title bar, as the title of the page, in the navigation and in the Dashboard.

  • Body - The main text of your Docs page. Docs pages use HTML to format the page (though Developer comments and annotations must be in Markdown). A link to Markdown tips is available at the top of the text box. To increase the height of the text box, use the dropdown list above to select a different height.

  • Tags - Categories for your Docs page. Be sure to read the information on planning your tags in Adding Content.

  • Change Summary - A listing of changes to the page, which is a helpful tool in scanning through past revisions.

  • Status - Specifies whether the content is in a draft stage or should be made public.

Custom Pages

Custom Pages are HTML pages with sidebars. Developers cannot leave comments on Custom Pages - making this document type a good choice for information you don't want to be commented on such as marketing-oriented content or terms.

To create a page for your Custom Pages area, enter the following information:

  • Document Path - The location of your Custom Page. Document Path is very important to the navigation of your Custom Pages, so plan your structure carefully. Links to Custom Pages are created by linking to your document path. For more information see Adding Content.

  • Title - The title of your custom page. This will appear in the title bar, as the title of the page, in the navigation, and in the Dashboard.

  • Body - The main text of your Custom Page. Custom Pages allow either HTML or Markdown to format the page. Here, because of the additional functionality allowed, we suggest HTML, though you will find link to Markdown tips at the top of the text box. To increase the height of the text box, use the dropdown list above to select a different height.

  • Sidebar - Custom Pages allow for more creativity and interesting layouts with the sidebar feature. In addition to the main content on your page, you can also provide text for display in a sidebar which can appear on the page so that this content attracts special notice.

  • Custom CSS – You will want to use a custom CSS stylesheet to format this particular Custom Page.

  • Tags - Categories for your Custom Page. Be sure to read the information on planning your tags in Adding Content.

  • Change Summary - A listing of changes to the page, which is a helpful tool in scanning through past revisions.

  • Order - The order of the Docs page in relation to its siblings in the Custom Page navigation.

  • Status - Specifies whether the content is in a draft stage or should be made public.

Blog

The Blog is a journal-like area for posting news and other timely information. Users can only comment on Blog entries and the comments can be moderated.

To create an entry for your Blog, enter the following information:

  • Title - The title of your entry, which will appear as the title in your RSS feeds as well.

  • Summary - A summary of your Blog entry.

  • Full Entry - The main text of your Blog entry. Your Blog uses Markdown to format the entry, as well as for any comments. If you are unfamiliar with the Markdown syntax, click the tips link for an explanation which is available at the top of the text box. To increase the height of the text box, use the dropdown list above to select a different height.

  • Tags - Categories for your Blog entry. Be sure to read the information on planning your tags in Adding Content.

  • Status - Specifies whether the content is in a draft stage or should be made public.

Forum

The Forum is a discussion area where users can post information and ask questions. You can choose to allow posts to display in the forum immediately or to wait for a moderator to approve the posts.

To create a Forum posting, enter the following information:

  • Topic - The topic of your entry.

  • Comment - The main text of your Forum post. Your Forum uses Markdown to format the post. If you are unfamiliar with the Markdown syntax, click the tips link for an explanation. A link to Markdown tips is available at the top of the text box. To increase the height of the text box, use the dropdown list above to select a different height.

  • Tags - Categories for your post. Be sure to read the information on planning your tags in Adding Content.

  • Status - Specifies whether the content is in a draft stage or should be made public.