[vdr] Re: Plugin Manuals: To all Plugin makers

[Mario Aistleitner <liste@humpen.at>]

Hello!

For the clock plugin I just added the following two lines in the Makefile in 
the section "all":

@mkdir ../../man
@cp README ../../man/$(PLUGIN).man

I hope this is what you wanted to do. I don't copy it as you told in your mail 
to the directory  /usr/local/src/VDR/plugin/man/ because it could be possible 
that somebody has not installed VDR to /usr/local/src/VDR. I also didn't use 
the variable $VDRDIR from the makefile because you wrote plugin (lower case) 
and in the actual version of VDR that I use (1.1.25) the directories letters 
are upper case. Because of a discussion earlier in the list I was not sure if 
the name will be changed to lower case in the future.

I already uploaded the modified plugin to my homepage http://vdr.humpen.at but 
I didn't change the version of the plugin. I think this is not realy a 
change. Maybe you could give a littlle feedback if this is okay like this.

best regards
Mario Aistleitner


On Saturday 22 February 2003 14:51, Reinhard Walter Buchner wrote:
> Hi Plugin makers,
>
> One of the next mods on my list is to integrate an
> on screen manual reader. This allows the user to
> readup on how to install or use (i.e. button useage,
> etc) the specific plugin.
>
> What I would like to ask you is if the following idea
> is okay:
>
>
> When doing a make plugins, could you tell your plugin
> to put the available readme into the following folder:
>
> /usr/local/src/VDR/plugin/man/YourPluginManualHere
>
> in order to keep the manuals unique, I would suggest
> using a name convention like: PluginName.man.
> For dvd this could be dvd.man (e.g.)
>
> I would like to avoid having to browse all across the
> harddisk, just to find some manuals (could be a problem,
> too, for a beginning VDR user), which is why I think a
> fixed place for readmes would be a good idea.
>
> The text should be plain ASCII (NO HTML tags PLEASE)
>
> If your plugin depends on another library AND this library
> contains sonething worth reading, you would either need to
> paste and copy this into your readme or at least make a note,
> where to find the readme of this "secondary" library.
>
> I WILL try to make the whole thing a la browser, still I think
> it would be best to include all readmes into one folder for
> quick & easy finding.
>
> Tell me what you think of it.
>
> Greetz,
> Reinhard
>
>
>
>
>
> ---
> Mail is certified Virus Free.
> Checked by AVG anti-virus system (http://www.grisoft.com).
> Version: 6.0.443 / Virus Database: 248 - Release Date: 10.01.2003



-- 
Info:
To unsubscribe send a mail to listar@linuxtv.org with "unsubscribe vdr" as subject.