Web Guidelines

The Basics:

Automated, Site-Wide Procedures

Introduction


Every project (module) of netbeans.org has its own web pages, located at http://module-name.netbeans.org/.

The owner of the project is responsible for maintaining these pages. If you want people to get interested and involved in your project, a good start is to put some relevant content up on your pages, explaining what the module does or will do.

All web pages for all projects have a few standard elements supplied by the infrastructure of the website. Things like the NetBeans logo and the standard navigation bar across the top will appear on all pages. These are not configurable per project.

Note: The site headers and footers are automatically wrapped around your content — you should not include them in your HTML. Take a look at the supplied templates below for examples.

Getting Started

Web pages for a module are maintained via WebDAV. Edit the files locally as you wish, and when done, upload the new versions to publish them. As a project maintainer you use your netbeans.org account as credentials. Read more about Working With Your Project's Website here. Alternatively you have the option to use a wiki as your project home page.

Here a few suggestions what to include on your project homepage

  • A description of the project: What is it, what will it do?
  • Current status, if appropriate
  • Screenshots, if appropriate
  • Members and contact info for feedback
  • Specs and proposals
  • TODO lists, future features lists

Style Sheets

We recommend you make use of the style sheets file available at https://netbeans.org/netbeans.css. To use it, include this css link in the head block of your HTML page.

<link rel="stylesheet" href="https://netbeans.org/netbeans3.css" type="text/css">

For more detail of how to make use of this guide, including a description and examples of all defined styles, please see the NetBeans CSS Guide.

Branding


All branding of pages is done automatically. This means the the logo, the navigation links, colours and styles etc are all "wrapped" around your content automatically, and you do not need to add them yourself.

It is possible to view your content without this automatic branding. This is really only useful for testing and troubleshooting, and we request you don't use this format for normal browsing or use of your content. To view the unbranded version of your page, append ?print=yes to the end of the URL, so for example

META tags

For best results in search engine listings, and also for use in your site map, please make use of META DESCRIPTION and KEYWORD tags! Use these tags to place a description of each page in the HEAD of your HTML. For example:

<META NAME="description" CONTENT="Guidelines for setting up your netbeans.org project website">

<META NAME="keywords" CONTENT="netbeans.org, project, homepage, website, owner">

Working on www.netbeans.org


The web-content project is a just like any other, however the NetBeans webteam have implemented a publishing system for www, and adding or editing content there is quite different than for other project websites. Please see the separate Working on www Guidelines for more details.

Linking to the www Website


There are a few key fixed URLs on the site: These are pages whose location is guaranteed not to move, so please use them if you need to link to the site from the IDE.

The current set of fixed URLs is:

If you need to link to a page not in this list from the IDE, please contact webmaster with details, we can add it. Obviously only fairly high-level and general links are suitable. See issue 34149 for more info.

Note that the real final content might not actually be at the above locations, but those pages will always redirect the user to the correct location.

Setting up http://<$your_language_here>.netbeans.org/

If you're interested in setting up a localised netbeans.org website, get in touch! We'd love to help get you started.

Contact the webmaster.

Not logged in. Log in, Register

By use of this website, you agree to the NetBeans Policies and Terms of Use. © 2013, Oracle Corporation and/or its affiliates. Sponsored by Oracle logo