|This FAQ text is copyright dslreports.com|
Reproduction of all or part only with our permission..
This FAQ is edited by: KeysCapt , climbers
It was last modified on 2008-06-30 21:26:18
1. General Info
Shortened Display for Larger FAQs
A new feature has been added which automatically reduces the largest FAQs on the site to a Table of Contents display ... for example, the Site FAQ
This was done to reduce the initial display of these larger FAQs, and make it easier for others, especially new users, to locate the subject they are seeking without having to scroll through a huge page of entries.
A new link has been placed at the FAQ head to automatically expand the FAQ to its full length when activated: Expand TOC and question shuffling
Smaller FAQs do not appear condensed in this manner.
Can I change my FAQ title?
In a word no.
10. Creating New FAQs
Some Site Philosophy on FAQs
One of the problems is that there is a lot of redundancy in the data across all FAQs. Worse, FAQs can disagree on the answers to the same questions, because they were maintained by different people at different times, and the site or subject changed over time. Also it has been pointed out that a few of the provider FAQs are bloated with outdated answers. There seems to be a desire in the larger FAQs for the FAQ to grow without bounds as it attempts to answer EVERY question that a particular forum-user has, instead of encouraging them to use the FAQ SEARCH to find the answers in other FAQs.
The guidelines for a good FAQ here should be that the FAQ sections and questions are all highly specific to the FAQ, and on-topic.
It's not really useful to have a FAQ explain what the term NID means, or how to get a gold star, unless the FAQ is, in the first case, a FAQ on network equipment terms, and in the second case, the site FAQ.
(The above is from a post by Justin)
How can I make a new FAQ for a particular subject?
Any registered BBR/DSLR member can start a new FAQ ... however, considering that the FAQ must be approved before it is made "public", or viewable, it is a good idea to ask someone before doing so. There may in fact already be a similar FAQ in progress, and so on.
That hurdle crossed, you will need to go to the All FAQs
page to get started. At the very bottom of that page, you will see this box:
In the box, enter the short
name for your FAQ. If it was for the Acme Widget forum, you might call it "acme". Then click on the "Create/Retrieve" button, and your FAQ will be started.
Next, enter the following URL into your browser address bar:/faq/
and at the end, add the short name that you entered above. This will be the address for your FAQ.
On your new FAQ page, you will see these items:
Clicking on "Edit FAQ Properties" will take you to a page where you can start entering your headers. Pay close attention to the info in the section of this FAQ entitled Starting Out
, because it's far easier to set these up correctly than to try to re-arrange them later.
If you get stuck, just get in touch with a mod.
Starting out - what to do first?
It is highly recommended that before you start creating entries in your new FAQ, you go to the "edit properties" page, and create your individual topics, or headings.
Once these have been created, changing them involves a lot of tedious work, so it's far better to get them right before you proceed with the "meat" of your FAQ.
It is also recommended that you utilize a proven numbering system which will allow you or others to add sections later. To do this, skip numbers as you make topic headings, as in:
|5.0|| ||Leaving Room|
|10.0|| ||Next Topic|
|15.0|| ||Another Topic|
This makes it relatively easy for you or another FAQ owner to add a new topic at a later date, and still have room for more.
In a pinch, if the FAQ you're working on wasn't set up this way, and you find yourself with this type of situation:
You can still squeeze a topic header in by using decimals, such as 1.1
or even 1.11
Structuring Your FAQ - Table of Contents
A recent change to the basic FAQ structure has created an automatic Table of Contents in all FAQs. It's automatic because it picks up each and every topic by number and creates the TOC based upon them.
It's a good idea, when building a new FAQ, to keep this in mind as you number and name your topics and their sub-topics. Topics are indented based upon their numbering; a major whole number like 3
is at the margin; sub-topics like 3.1
are indented. A further "child" like 3.12
will be indented once again.
Careful consideration while naming your topics will result in a useful and orderly Table of Contents in the finished FAQ.
How do I get my new FAQ public?
Certain moderators have the ability to make a new FAQ public. Just contact any mod and ask ... they will get in touch with those who can do it.
In general the FAQ should not be made public until such time as it is substantially complete and ready for approval.
I created it, but can't access it.
Occasionally, when a user creates a new FAQ on the New FAQ
page, a problem will develop where that user cannot access the FAQ for editing.
If this happens, notify a mod, who will contact one of the mods who can repair the problem. It may take a little time.
What NOT to do!
When you are creating new topic headers
in your FAQ ... that is, the items that have the numbers such as 1.0, 5.0 etc. ... do not
use any punctuation, such as apostrophes in contractions (won't, can't, etc.)
Doing so will cause your FAQ to crash, and a site superuser will have to revive it.
leave off the decimal after a topic number! Doing so will cause that topic to disappear and/or not be editable.
2.0 General Info
Not like this:
2 General Info
20. Writing New Entries
How do I start a new entry?
You do this the same way a regular user adds a potential FAQ submission ... by clicking on the link at the bottom of the FAQ:
The difference is, when you as a FAQ owner preview and then submit, the entry immediately becomes part of the finished FAQ, if the FAQ has been made public
By default, all new entries will go into the first topic in your FAQ if not changed. You make this selection in the box at the top of the screen.
Close Your HTML Tags
One of the common problems that crops up in the FAQs is failure to close HTML tags. This can cause all sorts of little irritating glitches, chief among which is failure to format your text properly.
If you use a tag such as <small> or <strong> it's important to include the closing tag at the end of the formatted text: </small>
One trick to remembering this is to type both tags at the same time: <small></small> ... then type your text in between the tags. It's helped me.
Using CSS for emphasis:
Cascading Style Sheet properties can be used with HTML to bring life to your FAQ entries.
Please remember that FAQs are for concisely sharing information -- don't get carried away.
A good use for CSS is to create notes, or warnings. Here is the code for a very simple warning box:
width:300px">Warning: Don't cut the BLUE wire!</p>
This is its result:
Warning: Don't cut the BLUE wire!
That is pretty effective as is, but by using some additional properties, it's possible to create a more sophisticated one. Here is the code:
border-color:red;border-style:dashed none dashed none;
Don't cut the <font color="red">RED</font> wire!</font></p>
This is the result:
Don't cut the RED wire!
If you're not already familiar with CSS and HTML, you can copy and paste the above code to use in your own FAQ entries. It's easy to change the colors and text.
CSS doesn't work the same in all browsers.
All the above code has been tested in Internet Explorer, Opera, and Firefox, and is viewable with the "printable all-text format" feature associated with a FAQ. This means it should work in all modern browsers. If you decide to experiment, other CSS code may not--test it.
If you'd like to learn more about CSS properties, here's a reference link:
Using SPAN tags for inline emphasis
SPAN tags can be used in FAQ entries for emphasis.
<span style="background-color:lightyellow"><b><font color="000000"
size="0">Click thumbnail to see full-size.</font></b></span>
Results in this:Click thumbnail to see full-size.
Unlike the techniques given here /faq/9301 the SPAN tags can easily be used inline to highlight a word or phrase.
<span style="background-color:lightyellow "><font color="000000"> <b>Don't</b>
</font></span> press the <span style="background-color:lightyellow">< font color="#FD0000">
Results in this: Don't
press the red button
NEW! Formatting Tools Added
Whenever you either create or edit a FAQ entry now, there are tools along the top of the editing window to make the job of formatting much easier. These can be seen in this image:
Here is a brief description of the buttons and their uses:
First two insert heading styles in two font sizes.
H4 is larger, unbolded type with a horizontal line,
H5 is bold font.
Next one inserts the HTML code for a paragraph, giving two line feeds.
Next is a link insert button, which opens a small window into which you can type or copy the URL you want to include.
Next are BOLD, Italics,
Strikethrough, Superscript and Subscript.
Next are the buttons for inserting a table, a table row, and a table definition ... saves you from having to type all those codes over and over.
Next, Unordered List, Ordered List, and Line insert for your lists. (Bulleted lists)
Next is Blockquote, which indents a paragraph or segment of text. This section is blockquoted.
The Code button allows the input of HTML or other coding without it being treated as such by the browser, and Comment is much the same, starts the line with an exclamation point and hypens to mark the following text as comment.
Close Tags is a quick way to enter closings for all the tags you have used, such as paragraph, font and table tags. Note that you may also type a section of text, higlight it, and then click on the format button you want to use. This will open and close the tags for that section of text.
The best way to get familiar with these new tools is to experiment.
25. How to include Links
Putting Links or URLs in FAQs
FAQ entries have been changed so that the same text processing that occurs in forum posts applies to FAQ editing now. Links will get converted, so there's no need to make them relative because of users from both domains. CODE and SYNTAX blocks will be treated as they are in posts also.
You may still wish to use HTML to display your URLs if, for instance, the title of the thread you're linking to is not descriptive enough. In that case, be sure to remove the domain info from the URL.
Any HTML in the faq QUESTION is now stripped out when saved, however, just as it is for forum topics.
How can I show HTML raw code?
The easiest way to do this is to substitute ASCII code for every beginning bracket, like this:
You must pay close attention though ... as soon as you preview this, it will be converted to normal HTML; that means when you hit "submit", your ASCII will now be HTML brackets, and the result will be the actual table.
To avoid that you must enter the ASCII, then preview it, and while in preview mode,
re-enter the ASCII in the preview window, then submit. It takes practice to get the hang of it, and is work-intensive enough to prevent you from doing it very often.
Another method, submitted by one of our FAQ owners:
"I use an alternate method for doing what's described in this entry, that some other folks might like. Type a FAQ entry that has raw HTML. Preview, and then if it needs edits, press the browser back button. Repeat this preview/back button process until your entry is complete. After the final preview, press the back button one more time, and then submit."
Submitted by Sidis
Using the CODE tags to show raw HTML
Raw HTML can easily be embedded in your entries by putting it in code blocks.
Code blocks begin with the [code]
tag, and end with a
[/code] tag, which you may be familiar with from posting to the BBR forums. After the system processes the code block, the raw HTML will be in a blue box with a dotted red outline which sets it off from the rest of your text.It's very important that the tags be on their own lines
, with the raw HTML between them. This:
results in this:
There can be spaces and multiple lines of raw HTML between the code tags.
results in this:
How many links can I have in an entry?
It depends on how you do them:
If you type in an address, and let the site autoconstruct them for you, like this:
which generates this: http://www.google.com
you can only have 30 per entry.
If you build them yourself, like this:
which generates this: www.google.com
there doesn't seem to be a limit.
You can mix both in an entry, but the limit is still 30 for the autogenerated kind.
And remember that if your HTML links (as in the second example) are links inside DSLR, you must remove the domain name: the »:www.dslreports.com
When creating internal links for the FAQ (or for other site links), is there a preference for using so called "relative" links, in order to keep the user from being logged out if he/she is logged in under the other domain?
Internal links, such as a link to a forum thread, must have the domain removed IF THEY ARE WRITTEN WITH HTML TAGS. If they are not, any user logged in under the other domain will be logged out upon clicking the link. If the link contains www.broadbandreports.com, a user logged in under dslreports.com will be logged out, and vice versa.
The solution is to write the URL in the same way it would be on an HTML page ... using the full
URL, but removing the
and looks like this:dslr terms of service
30. Editing Users Submissions
How do I know when there are entries to edit?
When a FAQ entry is submitted to a FAQ that you "own", you will receive a system message (flashing red icon)
. Opening it will display a message like this one:
(Thanks to Optimized for the graphic)
Going to your FAQ, you will see the new entry at the bottom of the page.
The entry is in small letters, and you can examine it by clicking on "edit". It may or may not be accompanied by a user's name ... if not, it is just a question with no answer.
If when you examine the entry, you find it is acceptable as is, check the topic that it is going under, and if satisfactory, hit "submit". Otherwise, edit as needed, preview and submit. If you wish to delete the entry, just hit the delete key.New:
If a FAQ owner does work on the FAQ, no other owners are notified. This is a recent change.
How can I delete a FAQ entry?
If this is an entry that has been submitted, but not yet added to the FAQ, you can simply click on "del" visible at the end of the proposed entry.
If you would like to delete a FAQ subject that has expired or is no longer accurate, you can do it by clicking on "del" at the bottom of the entry when viewing it.
Revision History and Manipulation
When viewing an individual FAQ entry, you will see a revision history
link at the bottom.
This allows you to view revisions that have been made to that entry, as in the following images:
The date shows the last revision, with the time. The first link, diff to current
when clicked yields the information in the second image:
The second, diff to 0
, will permit reversing the revision to the original form, but this is not functional yet
The date you will see in the revision history won't necessarily be the date of the most recent change, but reflects the previous version and the date it first appeared. Most of these are now showing 12/28/03.
Multiple changes to the FAQ by the same person, to the same entry, during an eight hour time period are squashed and only the last one made shows.01/04
At the top of your FAQ you will see a link called show hit count - trailing 7 day period
. The purpose of this is to change the view to show you the number of hits your FAQ topics have had in the past seven days. The hits are not
unique ... so if you've been working on one entry, for instance, and making numerous changes to it, each of those will constitute a hit.
In the image above, the bold numbers are the hits. While viewing these, the link will have changed to back to regular display
. Or just refreshing the page will cause it to revert to normal view.01/04
Basic Table Use
To include a table in your FAQ, you should have at least a cursory knowledge of HTML.
Basically, every HTML tag in a table requires a closing tag. Table can quickly grow to unmanageable proportions simply due to the large number of tags involved. Add in some align="center"
and other coding, and it becomes really complex.
A simple table to create some columns looks like this, for example:
<table align="center" width="90%" border="1" bgcolor="#CC0000"><tr><td align="center"><font color="white" face="garamond" size="+3">ONE</font></td><td align="center"><font color="white" face="garamond" size="+3">TWO</font></td><td align="center"><font color="white" face="garamond" size="+3">THREE</font></td><td align="center"><font color="white" face="garamond" size="+3">FOUR</font></td></tr></table>
That's a whole lot of coding to dress up one line with four cells in it.
Large white space before my table
So, you've just tediously written a nice table into your FAQ in order to show your info nicely set apart, but when you submit it, there's this massive "white space" between your regular text and your table. You've tried everything, and it just won't go away. What to do?
This is a result of spaces and line returns between table elements. Where that normally does not have any effect on a table, here on the site it is a no-no.
To fix the problem, edit your entry, and remove all spaces between table elements ... they should look like this:
<TABLE><TR><TD>some text information here</TD></TR> and so on. The only exception is that as you write your entry, some line breaks will occur naturally, put there by the site's software. Do not interfere with these; doing so will delete part of your text.
45. Bulleted Lists
Methods for bulleted and numbered lists
If you would like to use bullets beside your lists, there is only one method now:
< LI> First line
< LI> Second line
The above is an example of a bulleted list.
It is important
to open and close your list with the appropriate HTML tags, or your list will move out to the left margin.
46. Horizontal Rule Tags
Using Horizontal Rules
This tag is used frequently in HTML to divide a section of the page from another. It can be used for the same purpose in your FAQ, for example to create a break between an image and the body of text.
Simply including the <HR> tag will create a solid line from left margin to right margin like this:
You may adjust the width of your tag by including a width statement:
<HR width="75%"> results in a horizontal rule that looks like this:
The ability to include a color statement has been discontinued.
60. Using Colors
How to use colors in the FAQ
Colors can be used to good advantage in your FAQ, if you are selective about where you use them. Generally colors should be used for emphasis
, or to set certain text apart from the rest. It is important
to keep in mind that many site users have selected their own themes for viewing pages on the site, and this may conflict with the way they see your color selections.
The HTML for that colored text is: <font color="green"> and the closing </font>.
You can use color with text, backgrounds, or table borders, or a combination such as this:
The tag that makes this possible is the bgcolor
tag, as in: <TABLE bgcolor="yellow">
80. Using Images
How do I include a picture in my FAQ?
The method of including an image in your FAQ entry has changed, and is much simpler to use now.
When editing (or authoring) a FAQ entry, you will find an area at the bottom of the window to upload images:
Once you have browsed to the image on your machine and hit "upload", you will see this:
Hitting the "next" button takes you to the next page, where you will see your uploaded image:
Right below the uploaded image you see a reference number, in this case "attachment=1102246". Simply place "att=1102246" within brackets ... [ ] ... wherever you want the image to appear in your entry, like this:
Also note that there are useful links included during the process which allow you to show attachments that have been uploaded, and to show the upload screen when it isn't readily available.
Be advised that images larger than 600px will be automatically re-sized, and will look like this:
Changed a Topic Name, now there are two!
Any change you make to a topic header, no matter how insignificant, will result in the new one and the old one appearing in your FAQ. This means that in effect, you cannot alter an existing topic - you must create a new one (which you do when you make any change to your existing one) and then move all the sub-titles from the old one to the new one. After doing so, your old one will disappear.
I inherited a mis-numbered FAQ, what to do?
I became an editor for a FAQ without proper numbering. How do I fix it?
Many of the FAQs on the site were not properly numbered as they were developed, and for that reason they can be difficult to work with.
To correct the numbering of topics, create a properly numbered category to take the place of the old one, and then edit each entry in the incorrectly numbered one selecting the new topic in the drop-down menu.
When you've completed "moving" all entries, the old topic will disappear.
(Suggested by Sidis)
How do I delete a FAQ?
I have no answer for this one.
I do. You cannot. Only a Site Superuser can make a FAQ go away.
How to delete duplicate sections
I have duplicate numbered sections displayed in the FAQ, one is blank, but I don't see the duplicate when I'm editing it so I can't fix it.
How can I get rid of the duplicate?
• Create new category
• Copy over entries (copy/paste is easiest, but you'll lose the crediting of the submitter, so you'll need to put it in manually)
• Delete the original entry
• Delete category in the TOC
How do other users get added as FAQ owners?
If you are a listed "owner" of a FAQ and you, or maybe the forum host would like to add another user with permission to edit the FAQ, any site mod will be able to contact the appropriate person to accomplish this.
Can I re-order the sections of my FAQ?
Yes, you can re-order FAQ sections.
First, you need to change the title number of the section you want to move or create your new topic via "edit FAQ properties".
Next, you must edit each individual FAQ entry from the old section and change its location to the newly numbered section via "This question is for FAQ Section:".
Putting Site User Names in FAQs
Previously, to include a site user's name in a FAQ, such as giving credit to them for information, etc. it was necessary to use the long version HTML tags.
This has been eliminated, and you can now enter user names exactly as done in forum posts, using the xxxxxx7
Why doesn't my FAQ show up on my page?
Because this is not an automatic process. Every so often, an update is initiated, and ownerships will appear on the appropriate user pages.