:!: Online help is now maintained within Koha. Pages in koha.wiki.org are no longer used. (2009-07-30 - kf)

Contributing to these documents

We can always use all the help we can get writing documentation. Helping write online help for the Intranet interface is easy.

If you want to help, you should start by reading the Online Help Style Guide.

Identifying what needs to be written

The online help pages in the wiki have been laid out in the same way as the structure of the perl scripts in CVS see http://cvs.savannah.nongnu.org/viewcvs/koha/?root=koha#dirlist

If the script name looks like a link, then it will take you to a wiki page with the help content for that page.

If the script name does not look like a link, then this means that the help content needs to be written. Simply edit that parent page, select the script name and then use the Internal Link option (Ctrl + L) to make a new page for the help text. Please layout your content as per the Online Help Style Guide.

How will this help get into Koha

This section of work has yet to be done. What we will do is write a script to move the content of the wiki into the core CVS. The main thing is don't worry, if you write it, we will make sure it gets into CVS.

Good luck! Any questions fire them through to the koha-devel list or ask on the Koha IRC channel.

Bringing Across Existing Help Content

The first step is to go through and find the current online help documentation in CVS and copy and paste it into the wiki to edit there.

The help directory for the current default templates is here http://cvs.savannah.nongnu.org/viewcvs/koha/koha-tmpl/intranet-tmpl/default/en/help/?root=koha#dirlist

E.g for the script bull-home.tmpl

Go to the bull (serials) folder

http://cvs.savannah.nongnu.org/viewcvs/koha/koha-tmpl/intranet-tmpl/default/en/help/bull/?root=koha

Click on the script name

http://cvs.savannah.nongnu.org/viewcvs/koha/koha-tmpl/intranet-tmpl/default/en/help/bull/bull-home.tmpl?rev=1.1&root=koha&view=log

Next to the latest version number, in this case 1.1, click the “view” link

You will be taken to a page like this http://cvs.savannah.nongnu.org/viewcvs/koha/koha-tmpl/intranet-tmpl/default/en/help/bull/bull-home.tmpl?rev=1.1&root=koha&view=markup

The bit you want will be inbetween the TMPL tags

<!– TMPL_INCLUDE NAME=“help-top.inc” –>

      <h1>Serials subscription help</h1>
      <li>Search for a subscription by using the filter button (with a ISSN or a title). If you enter a title, you can use the wildcard % : entering <b>%Times%</b> returns every subscription containing Times in the title. Entering <b>New York%</b> returns every subscription with title starting 

with New York</li>

      <li>If you want to create a new subscription, clic on <span 

class=“button”>Add subscription</span> <!– TMPL_INCLUDE name=“help-bottom.inc” –>

So just delete the TMPL tags and you get

      <h1>Serials subscription help</h1>
      <li>Search for a subscription by using the filter button (with a ISSN or a title). If you enter a title, you can use the wildcard % : entering <b>%Times%</b> returns every subscription containing Times in the title. Entering <b>New York%</b> returns every subscription with title starting with New York</li>
      <li>If you want to create a new subscription, clic on <span class="button">Add subscription</span>

Now go to the corresponding page in the wiki,

In this case it is under bull, http://wiki.koha.org/doku.php?id=bull

Select the name of the script and then use the little link button (if you mouse over the interface button it should say internal link)

This will make a new page on the wiki for the help content. Hit SAVE and look at the current page, if you click on the link to your new page now, you will be taken to an empty page.

e.g. http://wiki.koha.org/doku.php?id=bull-home.tmpl

You can edit this page and copy in the content from CVS.

Note On Formatting Copied Content

The existing content is formatted using HTML tags, you may want to delete these out and replace them with the wiki formatting. As there are so few existing help pages, this shouldn't take too long :-)

Writing New Content

As soon as Ryan has the framework set up in the wiki, anyone and everyone can register for the wiki, read John's most excellent style guide and start going through and finding pages to write.

We will know when we have finished when each script name in the wiki links to a seperate help page.

What To Do If The Existing Help File Name And The Current Script Name Don't Match

In this case, make a new page with the file name of the script as per the framework Ryan has imported. There are a number of instances where the current help files are used on a number of pages in Koha.

What we should be doing is going through and making content for each one of the scripts in the framework. We will know when we are done when each script links to a wiki page with help content

 
en/documentation/contributing_to_online_help.txt · Last modified: 2009/07/30 03:05 by kf
 
Except where otherwise noted, content on this wiki is licensed under the following license:CC Attribution-Noncommercial-Share Alike 3.0 Unported
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki