Re: [jokosher-devel] Documentation Team - plan for 0.1



If anyone is interested, the User Guide is up on my site for your
perusal. Find it here: http://www.jeffratliff.org/jokosher/. The
screen shots aren't done, but the rest is. Let me know if there are
problems.

Nice!

Picky point: you shouldn't have the numbers in the header text, I
feel; that means that adding a new section requires editing all the
headers in the document.
Picky point again: it's worthwhile chucking it through the HTML
validator (http://validator.w3.org/check?verbose=1&uri=http%3A%2F%2Fwww.jeffratliff.org%2Fjokosher%2Fguide%2F)
for a few pointers on stuff that might need tweaking.
In particular, a sub-UL needs to still be in an LI, so instead of
<ul>
 <li>x</li>
 <ul>
   <li>sub</li>
 </ul>
</ul>
you need to do
<ul>
 <li>x</li>
 <li>
   <ul>
     <li>sub</li>
   </ul>
 </li>
</ul>

and images should still be in a paragraph. I'd recommend something like:
<p class="image">
 <img src="whatever">
 <span class="figure">Figure 2.2</span>
 <span class="caption">Image caption</span>
</p>

None of these things are massively important, they're just nitpicks. A
great job!

sil
--
If hard data were the filtering criterion you could fit the entire
contents of the Internet on a floppy disk.
            -- Cecil Adams



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]