Codex

Interested in functions, hooks, classes, or methods? Check out the new WordPress Code Reference!

User talk:MichaelH/FAQ

FAQ Names

I think we might need a FAQ page that covers WordPress Features - the "sales tool" page, and the Why Choose WordPress should go there. It's good to see things grouped like this to get a clearer picture.

Lorelle 15:44, 30 May 2005 (UTC)

LV is this correct? FAQ docs are to be:

  • FAQ (used to index the other FAQs) Would be nice if this had the TOC to all the other FAQs
  • FAQ Installation
  • FAQ WordPress Features
  • FAQ Configuration
  • FAQ Modifying
  • FAQ Layout and Design
  • FAQ Codex
  • FAQ Documentation
  • FAQ Developer
  • FAQ Administration
MichaelH (talk) 16:01, 30 May 2005 (UTC)

RE: above list. What's the difference between Configuration and Modifying? Modifying what? Design - goes under Layout. Code? Hmmmm. That's Configuration? I'd like it to sorta match the way the Codex TOC is laid out, if possible, so maybe Advanced Topics...still thinking.

Lorelle 16:10, 30 May 2005 (UTC)


How's this?

  • FAQ WordPress Basics
  • FAQ New To WordPress
  • FAQ WordPress Features
  • FAQ Blog Design and Layout
  • FAQ Advanced Topics
  • FAQ Troubleshooting
  • FAQ Developer Documentation
MichaelH (talk) 16:22, 30 May 2005 (UTC)


We need installation back in there....How about this - version 3.
  • FAQ
  • FAQ About WordPress (soon to formerly be "WordPress Basics")
  • FAQ Installation
  • FAQ New To WordPress
  • FAQ WordPress Features
  • FAQ Layout and Design
  • FAQ Using WordPress (emcompasses Config/Mod/etc)
  • FAQ Advanced Topics (how advanced? Is this devloper or Features or configuration?)
  • FAQ Troubleshooting
  • FAQ Developer Documentation
  • FAQ Codex
Lorelle 21:54, 30 May 2005 (UTC)


TOC Discussion

I haven't figured out how to move the TOC over to the left. I can't overwrite the default styles for it, so I'll have to ask Carthik about it. I added a clear:both div to force the text below the TOC, which is a start.

I also put the main sections into single = heading styles and left the stuff underneath in === styles. This made more of a separation between the sections. Also, I don't know if you caught this, but I think you did, be sure and change any of the code answers from <code> to <tt> as the code puts a blue background behind the text which makes it a little difficult to read and kind of ugly and the tt creates the monotype effect without the blue background - much cleaner.

This is a great look and a great start. Let's keep poking at it and start moving some of the other sections in. We we are ready, we can put the TOC into templates and then add them with the formatting to clean them up better, and that will also allow them to be used in a main FAQ page without doing redundant work. Whatcha think about that?

Lorelle 15:44, 30 May 2005 (UTC)

Using Templates, we can easily create the FAQ "main page" list.

Okay, first, take a look, if you haven't already, at the new template I added, per top mention. It's at Template:FAQ_Install for editing purposes. I just copied it from the View Source using the regular TOC, stripped the HTML and styled it. We need to play with colors and such, but I'm liking this.

Lorelle 16:10, 30 May 2005 (UTC)

Lorelle; the only problem with a Template for the TOC is that it is NOT self-maintaining. I think we need to find out how to let the TOC float left at the top so we don't have a bunch of TOC Templates to maintain.

MichaelH (talk) 16:59, 30 May 2005 (UTC)


For Task List - Cleaning FAQ

Here are some notes as a reminder of what we will need to tell people to do when it comes time to put the new FAQ in place and start cleaning:

  • When Administration Panels are mentioned, please link to them per Administration Panels links described already in the Codex:Tasks#Links_to_Administration_Panels_Page.
  • Change all usages of <code> to <tt> to maintain clean consistency.
  • Change all references to WP to WordPress.
  • Change all references to template tags and template files in paragraphs to match this bloginfo() and index.php usage form:
Change all references to template tags and 
template files in paragraphs to match this 
<tt>bloginfo()</tt> and <tt>index.php</tt> usage form
  • When an answer is now replaced by an article, link to it per:
How do I install WordPress?
See:
to create the See part use: See: then a line break, then an * and then the link
the above example is entered as:

See:

*[[Installing WordPress]]

  • Take care not to change or remove the section heading equal signs (=).
    • Two equal signs (==) before and after the text for a major heading
    • Three equal signs (===) before and after each question
  • If you spot a long answer to a question and it "feels" like it deserves an article, create a link to that question in the Tasks - FAQ section so an article may be written to replace it.
  • Check all external links to make sure they are still valid. Change the link or remove it if it is no longer good.


Lorelle 20:05, 4 Jun 2005 (UTC)