List Info

Thread: documentation improvements




documentation improvements
user name
2006-09-18 20:39:46
In trying to make instiki easier to use for my non-technical
colleagues, I made some changes to one file.  I'm not sure
how to
contribute my changes back to the project (and instiki.org
is down at
the moment) so I thought I'd just email my changes to this
list with
the hopes that someone more knowledgeable can incorporate
them
correctly into the project.

Note: In my Edit Web settings, I have the following 3
noteworthy settings:
1. Markdown selected for my Markup
2. Red selected for my color
3. "Brackets only" is checkmarked

Because I have Brackets only checked. I wanted to replace
the
CamelCase WikiWord documentation from the side of each edit
page with
double bracket new page creation documentation.  I also
wanted to add
documentation for how to upload images and files.  I
accomplished this
by replacing the contents of this file:
instiki/app/views/wiki_words_help.rhtml
...with this text:
<h3>How To Create New Pages</h3>
<table cellspacing="0"
cellpadding="0">
  <tr><td>[[new page name]] </td><td
class="arrow">&rarr;</td><td>
<span class="newWikiWord">new page
name</span><span style="text-decoration:
underline; color:
red;">?</span></td></tr>
  <tr><td
colspan="3"><em><p>Click red
question mark link to start
editing that new
page.</p></em></td></tr>
</table>
<p> </p><!-- spacer hack, this should be made
pretty with CSS, but
adding this paragraph is a quick fix -->
<h3>How To Upload Files and Images</h3>
<table cellspacing="0"
cellpadding="0">
  <tr><td>[[file name.jpg:pic]]</td><td
class="arrow">&rarr;</td><td>
<span class="newWikiWord">file
name.jpg</span><span style="text-decoration:
underline; color:
red;">?</span></td></tr>
  <tr><td>[[file
name.pdf:file]]</td><td
class="arrow">&rarr;</td><td>
<span class="newWikiWord">file
name.pdf</span><span style="text-decoration:
underline; color:
red;">?</span></td></tr>
  <tr><td
colspan="3"><em><p>Click red
question mark link to upload
your image or
file.</p></em></td></tr>
</table>

In case that code gets a bunch of line breaks added thru
email, I've
attached the file to this email as well.

Thanks,
Simon

-- 
Simon Dorfman  - Video Editor - NOA-TV
simonnoatv.com
(504) 483-3305
Fax (504) 304-7324

New Orleans Access Television
1025 S. Jefferson Davis Parkway
Suite B
New Orleans, LA 70125
http://noatv.com/
_______________________________________________
Instiki-users mailing list
Instiki-usersrubyforge.org
h
ttp://rubyforge.org/mailman/listinfo/instiki-users
[1]

about | contact  Other archives ( Real Estate discussion Medical topics )