Tips, Tricks and Code Tips, Tricks and Code

Back

Wiki - How to add content

Created by TECHcommunity team, last modified on Thu, 20 Jun 2019, 10:08

How to add wiki articles & tutorials to Tips Tricks and Code:

1.   Make sure you are logged in to the TECHcommunity

2.   Go to the Tips, Tricks and Code home page 

3.   Click on Add New button

4.   Enter the article or tutorial and hit Publish once done

Please let us know if you face some issues or need assistance.

For detailed instructions on using the Tips, Tricks and Code, please refer to the sections below:

Creating a Tips, Tricks and Code Page

Once you have selected the right product section in the main Navigation for your wiki article/tutorial and clicked on Add New you will arrive at the interface to create your own page.

You need to fill in the following details:

Title

That is the unique identifier for your contribution that also affects the URL of your article/tutorial. Make sure it is a meaningful one.

Format

With the TECHcommunity wiki you use a WYSWYG editor to post content.

The page will be rendered using HTML.

HTML

Allows you to add flash or YouTube videos to your pages and embed them in the HTML source.

You can check and edit the HTML code directly by clicking on the Source button.

Attachments

You can upload additional documents, images, etc to the wiki. You can do it either by drag and drop the files or by “Select Files” and uploading them to the article.

Tags

‘Tags’ field is mandatory if tags are missing you will not be able to "save" and will get an error. You can add as many tags as you wish. We strongly recommend you tag your article/tutorial with the product name at least.

Here are some of the benefits of adding the right tags:

  • Your content will become accessible via the tag cloud
  • It will appear on the products landing pages
  • When you are on the home page What’s New section your content will appear under the right product category

Related Assets

In this section, you can select wiki or blog entries that are related to your topic.

Page content

A good wiki page consists of:

Teaser

The teaser is a short summary of your article or tutorial giving the reader a quick overview of what this entry is about. If you add details on the applicable version, as well as date and time of the submission, you will make it easier to identify the relevance of the resource at a first glance.

Here is a good example of a teaser*:

This article describes various aspects of a Web service and its WSDL file. It also describes how certain of these aspects are supported by the different versions of Integration Server.
Submitted by: Shailen Prasad, Software AG, January 2012
Applicable Versions: 6.5 and later.

From the article Understanding Web Services

Different content sections

When structuring your page make sure you use different heading styles so that the content can be digested easier.

Examples

Here are a few randomly selected and well-formatted wiki entries

Understanding Web Services
Writing a Custom Content Handler for Integration Server
How to UploadDownload a File from MWS To IS

Please feel free to update the list with more wiki articles and tutorials that you find useful and easy to read.

Navigating in the wiki

Home

On click of it, you will arrive directly at the wiki home page

Recent changes

You can see the wiki articles and tutorials that have been changed recently

Draft pages

Here you can see your drafts.

Product filter from the top navigation

By selecting a Product from the main TECHcommunity navigation you see wiki articles and tutorials by this Product in the section Tips, Tricks and Code

Search in the wiki

Type the term/product you are looking for in the search field and click the Read button. This will show you results of wiki pages based on the search term you are looking for.

 


0 Attachments
5852 Views
Average (0 Votes)
Comments