Menu
▾
▴
#2072 (ok 2.9.0) FAQ numbers missing in Documentation.html
Recently the FAQ numbers have disappeared from
Documenation.html. This makes it really hard to point
users to the correct FAQ entry and additionally makes
that section look more cluttered to me, because it's
gone from an organized list of FAQ 1.1, 1.2, etc to a
random-looking list of questions and answers. Can we
re-add the numbers to the FAQ questions?
Discussion
Logged In: YES
user_id=418833
Erm, having a look at
http://www.phpmyadmin.net/documentation
I do see FAQ numbers there...
Logged In: YES
user_id=835650
Er, I don't see them. The FAQ entries themselves are there, and the links do
link properly down the page, but there are no numbers indicating each one to
a person browsing the page (or, for that matter, if one were to refer to the
FAQ page. Even if one provides a direct link to a FAQ entry, some browsers
aren't the best about displaying it (IE for one), and only link you "really close"
to the proper entry, so providing the actual number as a heading is helpful.
I attached a patch in the patch tracker which solves this problem, so this
request here could be outdated if that is accepted.
Hope I make sense...
Logged In: YES
user_id=418833
What browser are you using?
Could you provide a screenshot that demonstrates the missing
FAQ numbers?
I have attached a screenshot that shows you how the docs
look like on my machine.
Part of the HTML showing no numbers displayed
Logged In: YES
user_id=835650
* I've tried using Internet Explorer, Firefox, and Safari -
all with the same result.
* I've tried two or three different computers, one of which
happens to be brand new (so no old files in the cache) and
forced the page to reload (rather than cache) on the
systems.
* Viewing the page source just doesn't show it (everything
else looks okay, see attachment)
* At the moment the phpmyadmin.net/documentation site isn't
loading completely for me (and hasn't all weekend). It
stops under "currently phpmyadmin can" with "export1 data
to <abbr title="comma separated valu" -- so the picture
attachment was generated from the cihar.com demo, but looks
the same to me as the phpmyadmin.net site.
* Attachments:
1) screenshot (from IE 'cause that's what I'm using ATM)
which shows the problem (which I see from phpmyadmin.net (v
2.221), CVS HEAD (v 2.221), and cihar.com/HEAD(v 2.221).
All exhibit the same behavior to me).
2) text clipping from the HTML source showing no numbers
I see your screenshot and have no idea what could be
happening...we seem to be looking at the same thing but
somehow are seeing different things. I don't get it, but
hope my posting here helps someone figure it out :)
Logged In: YES
user_id=835650
By the way, this link will show the differences between
HEAD (2.221 which does not have numbers) and 2.205.2.13
(which is the most-recent commit I can find at the moment
that does have the numbers):
http://cvs.sourceforge.net/viewcvs.py/phpmyadmin/phpMyAdmin/
Documentation.html?r1=2.205.2.13&r2=2.221
Screenshot showing no numbers displayed
Logged In: YES
user_id=418833
Those changes go along with these:
http://cvs.sourceforge.net/viewcvs.py/phpmyadmin/phpMyAdmin/docs.css?r1=2.0&r2=2.1
As you can see, the FAQ numbers _should_ be added by CSS.
This is abviously not the case in your environment, so I'll
move this to the bugs tracker.
Logged In: YES
user_id=835650
Ah, I see, sorry for my not noticing that. Anyone with any
ideas how I can trace what's going on?
Logged In: YES
user_id=501368
I can confirm that no FAQ numbers are displayed in
"Mozilla/5.0 (X11; U; FreeBSD i386; en-US; rv:1.7.12)
Gecko/20051218 Firefox/1.0.7" as well.
And in "Mozilla/5.0 (compatible; Konqueror/3.4; FreeBSD;
X11; i386) KHTML/3.4.2 (like Gecko)" the numbering is even
more strange, for example:
- 12.1. Server
* 12.2.1. #faq1_1
* 12.2.3. #faq1_2
* 12.2.5. #faq1_3
* 12.2.7. #faq1_4
* 12.2.10. #faq1_5
...
- 12.3. Configuration
* 12.4.1. #faq2_1
...
See the jumps from 12.1. to 12.2.1. and from 12.2.1. to
12.2.3. or even from 12.2.7. to 12.2.10. (2 missing in
between)? I cannot attach a file, so no screenshot
possible, sorry.
Guess with current implementations of that
CSS-auto-numbering it is not a good idea to use it.
Logged In: YES
user_id=835650
I've done a little more testing, here are my results:
So far I've checked the following - all with the same
result (no numbers displayed, as seen in my screenshot
attachment):
* IE 6 viewing phpmyadmin.net and my Linux/Apache server
(with PMA CVS HEAD)
* Firefox 1.6/Win (viewing both the phpmyadmin.net site and
my server)
* Safari 2.0.3 (viewing phpmyadmin.net)
* Lynx 2.8.5 on Linux (phpmyadmin.net)
Firefox 1.5.0.1/Mac seems to work as expected (and is the
only browser I have access to that does so)
Logged In: YES
user_id=835650
Well, as the auto numbering seems to only work correctly
in very few situations (1), I propose (2) that the CSS-
controlled numbering be dropped. If manually maintaining
numbers is no longer desired, there are a couple of options:
* Use Documentation.php (instead of .html) and essentially
two counters (faq_major and faq_minor), automatically
incremented and printed at the appropriate locations --
this would at least automate the counting
* Transition to a new and improved documentation
style...perhaps maintaining it with DocBook or some other
markup-language type of system where the docs are compiled
in to .html -- complete with automated section numbering,
of course.
* It would be nice to split the FAQs off to another page,
my proposal would be creating a docs subdirectory of the
pma root, in which would be seperate files for FAQs, quick
start, configuration options, and general
documentation...though this may belong in a seperate RFE.
The current page is getting too long :(
1- in the other comments listed here, _only_ Firefox 1.5
seems to function as expected
2- yeah, I know my opinion doesn't count for much ;)
Logged In: YES
user_id=835650
Any status report on this? Has it been dismissed as
unimportant or user error? Has anyone had it work correctly
with any browser *except* FireFox 1.5?
Sorry to be a pest about it, but it's now very difficult to
refer users to specific FAQ entries.
Logged In: YES
user_id=210714
Isaac, I just sent a message to the -devel list about this,
supporting your idea of reverting to the non-CSS controlled
FAQ number.
Logged In: YES
user_id=210714
auto-numbering removed, hard-coded FAQ numbers are back.