How to edit project pages

Structure

For every OpenCores projects a number of pages are created upon startup of a new projects. The following pages are created

  1. Overview
  2. News
  3. Downloads
  4. Bugtracker

Only the maintainer(s) are allowd to apply changes to a project. New pages can be added with information related to the project. For the mandatory pages their content are described below.

Overview

Overview always contain a block with project details; name, start date, etc.
An other mandatory block is Other project details. This is for information regarding source language, wishbone compliancy etc.
As a maintainer you can add blocks to this page. A new block has a title and content. Pictures describing project functionality or intended use can be added. Pictures must first be included in the download page. Details regarding adding pictures are described later in this documnet. The order of the block can be changed by clicking on the little arrow symbol on the right of the project heading.

News

Add any news regarding project progress or usage in specific project or products

Downloads

Add pictures or documents related to the projects. Each item, document or picture, can be included in the Overview or other page added to the project.

Bugtracker

This page is used for the unlikely event of problems related to the project. Apart from bug reporting a user can add other project related information. New item are categorized into the following four types

  1. REQUEST
    Request for new functionallity
  2. BUG
    For bugs found in the IP
  3. IDEA
    Ideas that hopefully could be implemented in upcoming releases
  4. REMINDER
    Could be note to self

Frequently asked questions

  1. How to add a picture
    Add the picture in the download page. Select show embedd-tag. Copy content in pop-up window. Paste in block content.
  2. How to add a documnet
    Same as adding a picture
  3. Block content formatting corrupt, no newline
    If the block content is plain text with no HTML tags carrige returns will showed as line break. If the text contain valid HTML tags the whole text will be treated as HTML and should have valid HTML tag formatting the text.
    Note that a hyper text link is a HTML tag.
  4. How to add line break
    Use the following HTML tag: <br />
  5. How to format text
    Information on normal text formatting can be found here
  6. How to include tables
    Information on how to include tables can be found here
  7. How to format example of code snippets or examples on how to build targets
    To get monospace font and ligh gray background use paragraph where class="cmd"
    Example
    <p class="cmd">make all</p>
    will show as

    make all

© copyright 1999-2010 OpenCores.org, equivalent to ORSoC AB, all rights reserved. OpenCores®, registered trademark.