Difference between revisions of "Talk:Manual"

From TTWiki
Jump to navigationJump to search
m (12 revisions)
 
(Reformat and update)
Line 1: Line 1:
 
'''''Proposed changes and discussion about the manual.'''''
 
 
 
Any comments on the manual form in the wiki, and if things need to be changed, post them below.
 
Any comments on the manual form in the wiki, and if things need to be changed, post them below.
   
I've now fixed the last of the bugs in the script, and the present form of the manual is how it'll stay.  So feel free to edit pages, add more content, clarify things etc.
+
I've now fixed the last of the bugs in the script, and the present form of the manual is how it'll stay. So feel free to edit pages, add more content, clarify things etc.
   
Eventually I'd like every manual page to have two sections, a summary and a detailed information section.  The detailed information could possibly be inactive (using the TikiWiki DHTML features).  Also it might be good to change all the switch definitions to give the possible parameters, i.e. either "on|off" or "on|off|<value>", where value would be something that describes the meaning of this parameter.
+
Eventually I'd like every manual page to have two sections, a summary and a detailed information section. The detailed information could possibly be inactive (using the TikiWiki DHTML features). Also it might be good to change all the switch definitions to give the possible parameters, i.e. either "on|off" or "on|off|<value>", where value would be something that describes the meaning of this parameter.
   
 
I've removed the index since the site is searchable now, which is a lot better than looking something up in the index anyway.
 
I've removed the index since the site is searchable now, which is a lot better than looking something up in the index anyway.
   
{I just changed about a dozen wiki pages in the manual to include Quick Info sections. &nbsp;You can roll back the ones I did where I forgot to add comments; I have my work backed up on those and can re-add it with comments if needed. -Flamelord}
+
{I just changed about a dozen wiki pages in the manual to include Quick Info sections. You can roll back the ones I did where I forgot to add comments; I have my work backed up on those and can re-add it with comments if needed. -Flamelord}
   
{I noticed today that at least the manual pages have got plaintext that looks and acts like a link (Aside from the fact that it doesn't link to anywhere). &nbsp;It runs from the beginning of the page until the first actual link, then stops. &nbsp;Anyone have any idea what's wrong, or how it could be fixed? -Flamelord}
+
{I noticed today that at least the manual pages have got plaintext that looks and acts like a link (Aside from the fact that it doesn't link to anywhere). It runs from the beginning of the page until the first actual link, then stops. Anyone have any idea what's wrong, or how it could be fixed? -Flamelord}
   
That was actually a bug in Firefox and MSIE (and maybe others, but not Opera). They don't handle &lt;a name=&quot;foo&quot; /&gt; as they should. I've now change the anchors to be &lt;a name=&quot;foo&quot;&gt;&lt;/a&gt; instead, that seems to work. - patchman
+
That was actually a bug in Firefox and MSIE (and maybe others, but not Opera). They don't handle <a name="foo" /> as they should. I've now change the anchors to be <a name="foo"></a> instead, that seems to work. - patchman
   
-=Fix me=-
+
==Fix me==

Revision as of 12:56, 31 July 2011

Any comments on the manual form in the wiki, and if things need to be changed, post them below.

I've now fixed the last of the bugs in the script, and the present form of the manual is how it'll stay. So feel free to edit pages, add more content, clarify things etc.

Eventually I'd like every manual page to have two sections, a summary and a detailed information section. The detailed information could possibly be inactive (using the TikiWiki DHTML features). Also it might be good to change all the switch definitions to give the possible parameters, i.e. either "on|off" or "on|off|<value>", where value would be something that describes the meaning of this parameter.

I've removed the index since the site is searchable now, which is a lot better than looking something up in the index anyway.

{I just changed about a dozen wiki pages in the manual to include Quick Info sections. You can roll back the ones I did where I forgot to add comments; I have my work backed up on those and can re-add it with comments if needed. -Flamelord}

{I noticed today that at least the manual pages have got plaintext that looks and acts like a link (Aside from the fact that it doesn't link to anywhere). It runs from the beginning of the page until the first actual link, then stops. Anyone have any idea what's wrong, or how it could be fixed? -Flamelord}

That was actually a bug in Firefox and MSIE (and maybe others, but not Opera). They don't handle <a name="foo" /> as they should. I've now change the anchors to be <a name="foo"></a> instead, that seems to work. - patchman

Fix me