HowToAddFAQEntries

Contents


How to add/create a FAQ entry

Logging on

  1. When you are here for the first time ever, create your NetBeans Wiki account.
  2. Click "Log-in" and authenticate.
  3. Go to the FAQ site index (click "User FAQ" in the left column).
  4. Click on the “edit page” tab to go to the edit window. This window can look a little scary at first, but don't worry, you don't have to change that much to get an entry added to the FAQ. Note: Please do not delete existing content on this page. Just add your question as follows:

Adding a Question

  1. Scroll down to the section where you want to enter your FAQ item. A section starts with either a single ! or a double !!.
  2. Once you have reached the section you want, add another line below that looks just like this, but contains the question that you want to add.
* [[FaqTweedleDeeDumRefactoring|How can I refactor a tweedledeedum?]]

How do you read this line?

  • The star at the beginning places a bullet at the beginning of the list item. It must be followed by a space.
  • The first part in the double-brackets ("FaqTweedleDeeDumRefactoring" or "FaqHowToAsk") is the page name. It must be a wiki word: A wiki word should be CamelCase and be something short and descriptive. Look at other entries to get an idea. Good wiki words look like "HowToAsk", "HowToConfigure" or "WhatIsTheUpdateCenter", etc. It ends in a square bracket.
  • For user-FAQ entries, all user-faq entries should start with "Faq", as in "FaqHowToAsk".
  • Names of all plugin-developer FAQ items should start with "DevFaq", as in "DevFaqLookup". This keeps the FAQs organized and searchable and allows the giant developer FAQ page to be built.
  • In the middle there is a | between the question and the page title as a separator.
  • The second part is the question. It starts with a square bracket.
  • Note that the [[ | ]] braces make the entire thing a link to the actual answer page.


3. Click the Save button to save the page (or click Cancel to discard your changes).

Adding the Answer

1. Now you are back to view mode of the FAQ index page. Scroll down and find your question as one of the bullet items in the list - It will be red. Click on your new (red) link.
2. This will bring you to another edit window for the answer page. You can use the code below as a template for starting out your answer page, and fill in your own question (the same that you just entered into the FAQ index!) and answer.

====How can I refactor a tweedledeedum?====
Problem: Everytime I try to refactor a tweedledeedum, it starts burning.

Solution: You have to paint the tweedledeedum green first. 


3. Finally, add information at the bottom of the FAQ that tells what version of NetBeans and what OS platform the FAQ works with. Just add the versions and platforms that you know are right. If "See also:" information is useful, add it here also.

------------------------------------------
Applies to: NetBeans IDE 6.0 and 6.1
Platforms: All
See also: [[NetBeansUserFAQ| How can I refactor two tweedledeedums?]]


4. That's it. Click Save to save the page when you are done editing the answer.

What To Do About Long Lines of Text

If your FAQ entry includes <pre> tags (or you use the wiki convention of putting a space at the beginning of a line to do the same thing), avoid long lines of text. The FAQs are built every night into a giant HTML page. To keep it possible to print the entire FAQ on normal paper, please break up lines longer than 80 characters, or use <code> tags instead of <pre> (and make sure there are some whitespace characters in long lines) so that they can be formatted reasonably.

If your example does not have any lines > 80 characters, <pre> tags are fine.

Tip: Formatting

You can click on the Help tab (right beside the Edit tab) at any time to get help on formatting of the text. You won't lose your changes when switching between the help tab and the edit tab, so don't worry about that.

Now, start adding those FAQs!!

Source: JB's Blog

Not logged in. Log in, Register

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