tsiry-sandratraina.com / rockbox-zig
Rockbox open source high quality audio player as a Music Player Daemon
mpris rockbox mpd libadwaita audio rust zig deno
2
fork

Configure Feed

Select the types of activity you want to include in your feed.

manual nitpicking: add linebreaks in tables and fix cut off text

Cut off only happens in pdf output (fixed column width), not html.

Add \tabnlindent in favor of spaces in some places for consistent
display of multi-line-tag-parameters.

Change-Id: Ie2d4196da9fcd02af5e3ff72dcc9a97ae2d25303

authored by

Sebastian Leonhardt and committed by
Solomon Peachy af424280 aeaef9e4

+21 -16
+21 -16
manual/appendix/wps_tags.tex
··· 75 75 \opt{lcd_non-mono}{% 76 76 \config{\%Vs(mode[,param])} 77 77 & See section \ref{ref:Viewports}\\} 78 - \config{\%Vl('identifier',\newline\dots)} & Preloads a viewport for later 78 + \config{\%Vl('identifier',\tabnlindent\dots)} & Preloads a viewport for later 79 79 display. `identifier' is a single lowercase letter (a-z) and the `\dots' 80 80 parameters use the same logic as the \%V tag explained above.\\ 81 81 ··· 100 100 101 101 \section{Misc Coloring Tags} 102 102 \begin{tagmap} 103 - \config{\%dr(x,y,width,height,[color1,color2])} & Color a rectangle. \\ 103 + \config{\%dr(x,y,width,\tabnlindent height,[color1,\tabnlindent color2])} 104 + & Color a rectangle. \\ 104 105 \end{tagmap} 105 106 width and height can be ``$-$'' to fill the viewport. If no color is 106 107 specified the viewports foreground color will be used. If two ··· 197 198 198 199 \section{Playlist Viewer} 199 200 \begin{tagmap} 200 - \config{\%Vp(start,code to render)} & Display the playlist viewer in 201 + \config{\%Vp(start,\tabnlindent code to render)} & Display the playlist viewer in 201 202 the current viewport.\\ 202 203 \end{tagmap} 203 204 ··· 321 322 322 323 \section{Drawing the lists using a skin} 323 324 \begin{tagmap} 324 - \config{\%LT[(offset, nowrap)]} & Get the current items text, can be used in normal viewports to get the selected items text.\\ 325 - \config{\%LI[(offset, nowrap)]} & Get the current items icon number, can be used in normal viewports to get the selected items icon number.\\ 325 + \config{\%LT[(offset,\tabnlindent nowrap)]} & Get the current items text, 326 + can be used in normal viewports to get the selected items text.\\ 327 + \config{\%LI[(offset,\tabnlindent nowrap)]} & Get the current items icon 328 + number, can be used in normal viewports to get the selected items icon number.\\ 326 329 \config{\%LN} & Get the position of the current item in the list (1-based). Useful for displaying numbered lists.\\ 327 330 \config{\%LR} & Get the row number on which the current item will be drawn (1-based). Can be used to change the style based on where on the screen the item appears.\\ 328 331 \config{\%Lc} & Get the column number on which the current item will be drawn (1-based). Can be used to change the style based on where on the screen the item appears.\\ 329 332 \config{\%LC} & Use as a conditional to determine if the current item is the selected item\\ 330 333 \config{\%Lb} & BAR TAG to show the scroll bar, params/options like other bar types. It still needs a bit of work though. Use as a conditional to find out if the bar is actually needed\\ 331 - \config{\%LB(viewport, width, height [,tile])} & specify the viewport label to draw for each item and the size of each item. if the last param is 'tile' it will form a grid instead of a list\\ 334 + \config{\%LB(viewport,width,\tabnlindent height[,tile])} & specify the 335 + viewport label to draw for each item and the size of each item. if the 336 + last param is 'tile' it will form a grid instead of a list\\ 332 337 \end{tagmap} 333 338 \note{To do this you need at least one viewport which will be drawn for each item on the screen, and the ui viewport configured (using the %Vi tag). To make this work do the following: 334 339 Setup the ui viewport as normal. As many items as can fit in this viewport will be displayed (Titles are not included and need to be drawn in a seperate viewport manually) ··· 395 400 \config{\%X(filename.bmp)} 396 401 & Load and set a backdrop image for the WPS. 397 402 This image must be exactly the same size as your LCD.\\ 398 - \config{\%x(n,filename[,x,y])} 403 + \config{\%x(n,filename\tabnlindent[,x,y])} 399 404 & Load and display an image\newline 400 405 \config{n}: image ID for later referencing in \config{\%xd}\newline 401 406 \config{filename}: file name relative to \fname{/.rockbox/} and including ``.bmp''\newline 402 407 \config{x}: x coordinate (defaults to 0 if both x and y are not specified)\newline 403 408 \config{y}: y coordinate. (defaults to 0 if both x and y are not specified)\\ 404 - \config{\%xl(n,filename,[x,y],\tabnlindent[nimages])} 409 + \config{\%xl(n,filename,\tabnlindent[x,y],[nimages])} 405 410 & Preload an image for later display (useful for when your images are displayed conditionally).\newline 406 411 \config{n}: image ID for later referencing in \config{\%xd}\newline 407 412 \config{filename}: file name relative to \fname{/.rockbox/} and including ``.bmp''\newline ··· 410 415 \config{y}: y coordinate. (defaults to 0 if both x and y are not specified)\newline 411 416 \config{nimages}: (optional) number of sub-images (tiled vertically, of the same height) 412 417 contained in the bitmap. Default is 1.\\ 413 - \config{\%xd(n[i] [,tag] [,offset])} & Display a preloaded image. 418 + \config{\%xd(n[i] [,tag]\tabnlindent[,offset])} & Display a preloaded image. 414 419 \config{n}: image ID as it was specified in \config{\%x} or \config{\%xl}\newline 415 420 \config{i}: (optional) number of the sub-image to display (a-z for 1-26 and A-Z for 27-52). 416 421 (ignored when \config{tag} is used). Only useable if the ID is a single letter. ··· 547 552 & If / Else: Evaluate for true or false case \\ 548 553 \config{\%?xx<alt1|alt2|\tabnlindent{}alt3|\dots|else>} 549 554 & Enumerations: Evaluate for first / second / third / \dots / last condition \\ 550 - \config{\%if(tag, operator, operand, [option count])} 555 + \config{\%if(tag,operator,\tabnlindent{}operand,\tabnlindent[option count])} 551 556 & Allows very simple comparisons with other tags.\newline 552 557 \config{tag}: the tag to check against.\newline 553 558 \config{operator}: the comparison to perform -- possible options are =, !=, ··· 555 560 \config{operand}: either a second tag, a number, or text.\newline 556 561 \config{[option count]}: optional parameter used to select which parameter 557 562 of a tag to use when the tag has multiple options, e.g. \%?pv<a|b|c|d>\\ 558 - \config{\%and(tag1, tag2, ..., tagN)}\newline 563 + \config{\%and(tag1,tag2,\tabnlindent{}...,tagN)}\newline 559 564 & Logical ``and'' operator. Will be evaluate to true if all the tag parameters are true.\\ 560 - \config{\%or(tag1, tag2, ..., tagN)}\newline 565 + \config{\%or(tag1,tag2,\tabnlindent...,tagN)}\newline 561 566 & Logical ``or'' operator. Will be evaluate to true if any of the tag parameters are true.\\ 562 567 \end{tagmap} 563 568 ··· 576 581 \section{Subline Tags} 577 582 578 583 \begin{tagmap} 579 - \config{\%t(timeshow [,timehide])} & Set the subline display cycle time.\\ 584 + \config{\%t(timeshow\tabnlindent[,timehide])} & Set the subline display cycle time.\\ 580 585 \end{tagmap} 581 586 Use this tag to set the time a subline is displayed and optionally the amount of time to hide the line before line will be displayed again 582 587 \begin{description} ··· 710 715 } 711 716 712 717 \begin{tagmap} 713 - \config{\%XX(x, y, width, height, [options])} 718 + \config{\%XX(x,y,width,\tabnlindent{}height,[options])} 714 719 & Draw the specified tag as a bar\newline 715 720 \config{x}: x co-ordinate at which to start drawing the bar.\newline 716 721 \config{y}: y co-ordinate at which to start drawing the bar (- to make the ··· 762 767 \section{Other Tags} 763 768 764 769 \begin{tagmap} 765 - \config{\%ss(start, length, tag [,number]} & Get a substring from another tag.\\ 770 + \config{\%ss(start,length,\tabnlindent tag[,number])} & Get a substring from another tag.\\ 766 771 \end{tagmap} 767 772 Use this tag to get a substring from another tag. 768 773 \begin{description} ··· 775 780 \end{description} 776 781 777 782 \begin{tagmap} 778 - \config{\%ft(filename [,line|search text]} & Get a line of text from a file.\\ 783 + \config{\%ft(filename[,line\tabnlindent|search text])} & Get a line of text from a file.\\ 779 784 \end{tagmap} 780 785 Use this tag to check for the existence of a file, read a line or search for a line in a file. 781 786 Checking if a file exists can be done with \%?ft(filename)<Found|NotFound>\newline