[disorder] / templates / macros.tmpl

This file is part of DisOrder.
Copyright (C) 2008 Richard Kettlewell

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
USA


------------------------------------------------------------------------
Standard macros


This file is read before any other template.  Its output is discarded
but side effects (definitions of macros) are retained.  To override it,
create /etc/disorder/macros.tmpl that includes this file by absolute path
and then redefines macros as desired.
------------------------------------------------------------------------


@# Standard width and height of an image
@define {width} {} {16}
@define {height} {} {16}

@# Standard <head> text
@#  @name is the name of this page, for the <title> element
@define {stdhead} {name}
        {@quiethead
<title>@label{@name.title}</title>}

@# Non-displaying <head> text
@define {quiethead} {}
        {  <link rel=stylesheet
        type="text/css"
        href="@label{url.static}/disorder.css">}

@# Standard menu
@#   @current is the name of the current page, e.g. choosealpha, login
@define {stdmenu} {current}
        {  <p class=menubar>
@menuitem{@current}{playing}{true}
@menuitem{@current}{recent}{true}
@menuitem{@current}{choose}{@right{play}}
@menuitem{@current}{manage}{true}
@menuitem{@current}{login}{true}
@menuitem{@current}{help}{true}
@menuitem{@current}{about}{true}
   </p>
   <hr>
}

@# Menu entry
@#  Used by @stdmenu
@#  @current is the name of the current page (not necessarily the action that
@#           got there!)
@#  @name is the name of the menu item
@#  @available is true if the menu item is available, else false
@#  
@define {menuitem} {current name available}  
        {@if{@available}
            {   <a @if{@eq{@current}{@name}}
   	              {class=activemenu}
		      {class=inactivemenu}
@if{@eq{name}{playing}}
   {      href="@url"}
   {      href="@url?action=@name"}
      title="@label{menu.@q{@name}verbose}">@label{menu.@name}</a>}
            {   <span class=invalidmenu 
         title="@label{menu.@q{@name}verbose}">@label{menu.@name}</span>}}


@# Standard footer text
@define {credits} {}
        {<p class=credits>
  <a href="http://www.greenend.org.uk/rjk/disorder/"
     title="DisOrder web site">DisOrder
     version @version</a>
  &copy; 2003-2008 Richard Kettlewell et al
</p>}

@# Expand to the time that @id will be played
@#  @what is the section
@#  @id is the track ID
@define {mwhen} {what id}
        {@when{@id}</td>}

@# Expand to the 'who' field for @id
@#  @what is the section
@#  @id is the track ID
@define {mwho} {what id}
        {@if{@eq{@who{@id}}{}}
            {@if{@eq{@state{@id}}{random}}
                {@label{@what.randomtrack}}
                 {&nbsp;}}
            {@who{@id}}}

@# Expand to the artist for @track
@#  @what is the section
@#  @track is the track name
@define {martist} {what track}
        {@right{play}
               {<a class=directory
                   href="@url?action=choose&amp;directory=@urlquote{@dirname{@dirname{@track}}}"
                   title="@label{@what.artistverbose}">@part{@track}{artist}{short}</a>}
               {<span class=directory
                      title="@part{@track}{artist}">@part{@track}{artist}{short}</span>}}

@# Expand to the album for @track
@#  @what is the section
@#  @track is the track name
@define {malbum} {what track}
        {@right{play}
               {<a class=directory
                   href="@url?action=choose&amp;directory=@urlquote{@dirname{@track}}"
                   title="@label{@what.albumverbose}">@part{@track}{album}{short}</a>}
               {<span class=directory
                      title="@part{@track}{album}">@part{@track}{album}{short}</span>}}

@# Expand to the title for @track
@#  @what is the section
@#  @track is the track name
@define {mtitle} {what track}
        {<span title="@part{@track}{title}">@part{@track}{title}{short}</span>}

@# Expand to the remove/scratch entry for @id
@#  @what is the section
@#  @id is the track ID
@define {mremove} {what id}
        {@if{@removable{@id}}
            {<a class=imgbutton
                href="@url?action=remove&#38;id=@id@back">
               <img class=button src="@image{remove}"
                    width=@width height=@height
                    title="@label{@what.removeverbose}"
                    alt="@label{@what.scratch}">
             </a>}
            {<img class=button src="@image{noremove}"
                  width=@width height=@height
                  title="@label{@what.removeverbose}"
                  alt="@label{@what.scratch}">}}

@# Expand to a move button
@#  @id is the track ID
@#  @dir should be a direction: up, upall, down or downall
@#  @delta should be the distance, +ve for up and -ve for down
@# This macro calls @movable to check that the move is possible.
@define {mmove} {id dir delta}
        {@if{@movable{@id}{@delta}}
            {<a class=imgbutton
                href="@url?action=move&#38;id=@id&#38;delta=@delta@back">
               <img class=button src="@image{@dir}"
                    width=@width height=@height
                    title="@label{playing.@q{@dir}verbose}"
                    alt="@label{playing.@dir}">
             </a>}
            {<img class=button src="@image{no@dir}"
                  width=@width height=@height
                  title="@label{playing.@q{@dir}verbose}"
                  alt="@label{playing.@dir}">}}

Local variables:
mode:sgml
sgml-always-quote-attributes:nil
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
fill-column:79
End:
Commit	Line	Data
460b9539	1	This file is part of DisOrder.
1a3dba67	2	Copyright (C) 2008 Richard Kettlewell
460b9539	3
	4	This program is free software; you can redistribute it and/or modify
	5	it under the terms of the GNU General Public License as published by
	6	the Free Software Foundation; either version 2 of the License, or
	7	(at your option) any later version.
	8
	9	This program is distributed in the hope that it will be useful, but
	10	WITHOUT ANY WARRANTY; without even the implied warranty of
	11	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	12	General Public License for more details.
	13
	14	You should have received a copy of the GNU General Public License
	15	along with this program; if not, write to the Free Software
	16	Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
	17	USA
9faa7a88	18
0d0253c9 RK	19
	20	------------------------------------------------------------------------
	21	Standard macros
	22
	23
	24	This file is read before any other template. Its output is discarded
	25	but side effects (definitions of macros) are retained. To override it,
	26	create /etc/disorder/macros.tmpl that includes this file by absolute path
	27	and then redefines macros as desired.
	28	------------------------------------------------------------------------
	29
	30
1a3dba67 RK	31	@# Standard width and height of an image
	32	@define {width} {} {16}
	33	@define {height} {} {16}
	34
0d0253c9 RK	35	@# Standard <head> text
	36	@# @name is the name of this page, for the <title> element
	37	@define {stdhead} {name}
	38	{@quiethead
0d0253c9 RK	39	<title>@label{@name.title}</title>}
	40
	41	@# Non-displaying <head> text
	42	@define {quiethead} {}
99955407 RK	43	{ <link rel=stylesheet
	44	type="text/css"
	45	href="@label{url.static}/disorder.css">}
0d0253c9 RK	46
	47	@# Standard menu
	48	@# @current is the name of the current page, e.g. choosealpha, login
	49	@define {stdmenu} {current}
99955407	50	{ <p class=menubar>
0d0253c9	51	@menuitem{@current}{playing}{true}
99955407	52	@menuitem{@current}{recent}{true}
0d0253c9	53	@menuitem{@current}{choose}{@right{play}}
0d0253c9 RK	54	@menuitem{@current}{manage}{true}
	55	@menuitem{@current}{login}{true}
	56	@menuitem{@current}{help}{true}
	57	@menuitem{@current}{about}{true}
99955407 RK	58	</p>
99955407 RK	59	<hr>
0d0253c9 RK	60	}
	61
	62	@# Menu entry
	63	@# Used by @stdmenu
	64	@# @current is the name of the current page (not necessarily the action that
	65	@# got there!)
	66	@# @name is the name of the menu item
	67	@# @available is true if the menu item is available, else false
	68	@#
	69	@define {menuitem} {current name available}
	70	{@if{@available}
99955407 RK	71	{ <a @if{@eq{@current}{@name}}
	72	{class=activemenu}
	73	{class=inactivemenu}
	74	@if{@eq{name}{playing}}
	75	{ href="@url"}
	76	{ href="@url?action=@name"}
	77	title="@label{menu.@q{@name}verbose}">@label{menu.@name}</a>}
	78	{ <span class=invalidmenu
	79	title="@label{menu.@q{@name}verbose}">@label{menu.@name}</span>}}
0d0253c9	80
9faa7a88	81
0d0253c9 RK	82	@# Standard footer text
	83	@define {credits} {}
	84	{<p class=credits>
	85	<a href="http://www.greenend.org.uk/rjk/disorder/"
	86	title="DisOrder web site">DisOrder
	87	version @version</a>
	88	© 2003-2008 Richard Kettlewell et al
	89	</p>}
a2c4ad5f RK	90
a2c4ad5f RK	91	@# Expand to the time that @id will be played
1a3dba67 RK	92	@# @what is the section
1a3dba67 RK	93	@# @id is the track ID
a2c4ad5f RK	94	@define {mwhen} {what id}
	95	{@when{@id}</td>}
	96
	97	@# Expand to the 'who' field for @id
1a3dba67 RK	98	@# @what is the section
1a3dba67 RK	99	@# @id is the track ID
a2c4ad5f RK	100	@define {mwho} {what id}
	101	{@if{@eq{@who{@id}}{}}
	102	{@if{@eq{@state{@id}}{random}}
	103	{@label{@what.randomtrack}}
	104	{ }}
	105	{@who{@id}}}
	106
	107	@# Expand to the artist for @track
1a3dba67 RK	108	@# @what is the section
1a3dba67 RK	109	@# @track is the track name
a2c4ad5f RK	110	@define {martist} {what track}
	111	{@right{play}
	112	{<a class=directory
	113	href="@url?action=choose&directory=@urlquote{@dirname{@dirname{@track}}}"
99955407	114	title="@label{@what.artistverbose}">@part{@track}{artist}{short}</a>}
a2c4ad5f	115	{<span class=directory
99955407	116	title="@part{@track}{artist}">@part{@track}{artist}{short}</span>}}
a2c4ad5f RK	117
a2c4ad5f RK	118	@# Expand to the album for @track
1a3dba67 RK	119	@# @what is the section
1a3dba67 RK	120	@# @track is the track name
a2c4ad5f RK	121	@define {malbum} {what track}
	122	{@right{play}
	123	{<a class=directory
	124	href="@url?action=choose&directory=@urlquote{@dirname{@track}}"
99955407	125	title="@label{@what.albumverbose}">@part{@track}{album}{short}</a>}
a2c4ad5f	126	{<span class=directory
99955407	127	title="@part{@track}{album}">@part{@track}{album}{short}</span>}}
a2c4ad5f RK	128
a2c4ad5f RK	129	@# Expand to the title for @track
1a3dba67 RK	130	@# @what is the section
1a3dba67 RK	131	@# @track is the track name
a2c4ad5f	132	@define {mtitle} {what track}
99955407	133	{<span title="@part{@track}{title}">@part{@track}{title}{short}</span>}
a2c4ad5f RK	134
a2c4ad5f RK	135	@# Expand to the remove/scratch entry for @id
1a3dba67 RK	136	@# @what is the section
1a3dba67 RK	137	@# @id is the track ID
a2c4ad5f RK	138	@define {mremove} {what id}
	139	{@if{@removable{@id}}
	140	{<a class=imgbutton
	141	href="@url?action=remove&id=@id@back">
	142	<img class=button src="@image{remove}"
30d85588	143	width=@width height=@height
a2c4ad5f RK	144	title="@label{@what.removeverbose}"
	145	alt="@label{@what.scratch}">
	146	</a>}
	147	{<img class=button src="@image{noremove}"
30d85588	148	width=@width height=@height
a2c4ad5f RK	149	title="@label{@what.removeverbose}"
	150	alt="@label{@what.scratch}">}}
	151
af106f2d	152	@# Expand to a move button
1a3dba67	153	@# @id is the track ID
af106f2d RK	154	@# @dir should be a direction: up, upall, down or downall
	155	@# @delta should be the distance, +ve for up and -ve for down
	156	@# This macro calls @movable to check that the move is possible.
	157	@define {mmove} {id dir delta}
	158	{@if{@movable{@id}{@delta}}
	159	{<a class=imgbutton
	160	href="@url?action=move&id=@id&delta=@delta@back">
	161	<img class=button src="@image{@dir}"
30d85588	162	width=@width height=@height
af106f2d RK	163	title="@label{playing.@q{@dir}verbose}"
	164	alt="@label{playing.@dir}">
	165	</a>}
	166	{<img class=button src="@image{no@dir}"
30d85588 RK	167	width=@width height=@height
	168	title="@label{playing.@q{@dir}verbose}"
	169	alt="@label{playing.@dir}">}}
5fb0c1a0 RK	170
	171	Local variables:
	172	mode:sgml
	173	sgml-always-quote-attributes:nil
	174	sgml-indent-step:1
	175	sgml-indent-data:t
	176	indent-tabs-mode:nil
	177	fill-column:79
	178	End: