Home

YoDJ Configuration Information


There are many options that You can use to customize YoDJ. Use only the ones that you need to override default behavior. Some options are in place for thoroughness more than necessity. Boolean options can be true or false or yes or no - either will work. None of the options are case sensitive, but their values are e.g.. true/false should be lower case. Some operating systems are case sensitive, so make sure the filenames and directory names match case.

These options generally control how YoDJ behaves. You can change color, alignment and most visual elements in the YoDJ.CSS file.

Note:

RootDir and WebRoot must be set correctly for YoDJ to run..

YoDJ.ini

RootDir

Physical path to music or media files.

Default: {dummydir}

WebRoot

WebServer Alias to Music.

Default: /Music/

Frames

Enable or Disable Frames. The advantage of using frames is that all the buttons will be visible on the screen and never scroll off

Default:false

CSSFrames
Registered Version Only

Use CSS for Frames instead of HTML frames. If you have Frames set to True, this will turn it off. The upside to using CSS frames is that the page is rendered as one page instead of three pieces. This might be a little faster and it is a more modern way of rendering a page. The downside is that the Mouse Scroll Wheel seems to only work with Windows Explorer and not with any other browser or on any other platform. Since scrolling long lists with a scroll wheel is so useful, the system defaults to HTML frames, but you can override this.

Default:false

CSSFrameHeight
Registered Version Only

This is a bit of a cheat. The CSS height should be defined in the CSS file, but some users may not want to play with the CSS file. You can set the frame height in the CSS file, but you can override the height with this value. Consider it a convenience. The value must be given as either pixels(px) or em e.g.. 30em

Default:0

HeaderFile
Registered Version Only

Inject an HTML header at the top of the screen. The SiteName string is superfluous at this point and is not displayed. Your header will use the body style defined in the CSS file unless you override it in your header.

Default:None

FooterFile
Registered Version Only

Inject an HTML footer below the command buttons and above the vendor logo and version string (see below).

Default:None

NoVendorFoot
Registered Version Only

Disables the vendor footer data such as version number and Powered By Logo. This will make me sad, but it is your screen.

Default:false

ReadID3Tag
Registered Version Only

Read ID3 Tags for Song Length.

Default: Default True, disabled and false in Demo Version

Include
IncludeINI

Include from a second ini file. This can be handy when you are running several YoDJ Sites from the same directory. YoDJ looks for an ini file with the same base name as itself, so if you rename YoDJ.PHP to Blues.php it will look for Blues.INI. The demo on this site uses this feature. You can put most of your standard settings in a general include file.

Be careful about a recursive include. Don't have A include B and B include A.

Why two variable names? Just to make life easier.

Default: false

HomeUrl="http://www.somewhere/something.xxx"

By default, YoDJ will detect the referring page that linked to YoDJ. In other words, if you have a link in a web page, YoDJ will automatically show a HOME button that takes the user back to that page. If you want to override the referring url that YoDJ uses, you can do so with this setting. Under normal circumstances you won't use this. I use it on my demo page.

Make sure that you enclose the complete URL in quotes.

Default: false

NoHome

This disables the HOME button in YoDJ. If you set this to true, the HOME button will not appear when YoDJ is launched from a web page link. This option was added for completeness. Under normal circumstances, the HOME button is a real convenience to your users.

Default: false

GoodTypes

Media types accepted in comma delimited form

Default: mp3, m4a

CannedPlay

File extensions for Canned or Stored Playlists

These stored playlists are simply playlists as generated by YoDJ, but they are displayed as selectable files. A user can select more than one stored playlist and even mix stored playlists with other tracks. The music listed inside the stored playlists does not have to be visible to YoDJ, so you could - if you want - use this feature to make some music playable only through these canned playlists.

If the Playlist was created as an extended format playlist, it will be converted to a simple form on the fly according to the settings in your INI file.

You do not need to change the extensions with this setting to make this feature work. This setting just allows you to override the known extensions.

Default Extensions: m3u, .play and .playlist

NotesExtension

extension for the notes control file. Do not give just a period! See below for notes syntax.

Default: note

NotesPrefix

prefix to notes files.

Default: "_"

FoldersPlayable

Default Play mode for all folders. Set this to the value that will require the fewest overrides

Default: true

FilesPlayable

Default Play mode for all files.

Default: true

FilesDownloadable

Default download mode for all files.

Default: false

MaxPlayListCount

Max number of files that can be streamed at one time

Default: 100

TableStylerows

This corresponds to the number of row styles defined in your stylesheet. You can define as many as you like but 2 seems reasonable.

Default: 2

OwnerName

Name of the Public Operator of the web site

Default: Mr Silly

email

Owner or contact Email address

Default: bozo@bozo.com

SiteName

Name of the YoDJ browser. You can also embed pretty much anything you want in here including HTML. Just remember to keep it in quotes

Default: Beta YoDJ Browser

DefaultChecked

Default check mode for browsing. Unless you have a tiny number of tracks, you should leave this false.

Default: false

PlayListChecked

Default check mode when viewing playlist. It Makes sense to leave this true as this is expected behavior.

Default: true

EnableSearch

Enable Search mode. If you have a huge or slow file system you may want to turn this off, but before you do experiment with the speed or the search. It is pretty fast.

Default: true

FrameSizes

Framesizes, comma delimited: use wildcard for center frame
If you make changes to the top logo, you may need to adjust this

Default: 23%, *, 25%

CheckBoxWidth

Width of checkbox field. There is no reason to change this from the default

Default: 2%

PlayIconWidth

Width of Play Icon. The default value matches the default icon, but you may have to adjust this if you use a different icon

Default: 3%

FolderAndFileIconWidth

Width of Folder Icon. The default value matches the default icon, but you may have to adjust this if you use a different icon

Default: 3%

StatsWidth

Width of File and Folder stats field on the right of listings. This value needs to allow for all the combinations of field and folder ccounts

Default: 15%

PrependHTTP

This only matters if you are hosting on a site using a domain name. Some media players and hosts get unhappy when they do not see the 'http://' in front of a www. field. The default is true and is harmless. All it will do is prepend http:// if it doesn't see one in the server string.

Default: true

UseExtM3u

Use extended M3u format. Some media players - notably those from Microsoft do not handle this well. YoDJ tries to detect this and use old syle when possible, but the default is off. The Sample INI file sets this to true

Default: false

NoExtM3uforWMMm

Do not use extended format M3u format with Windows Media Player. Recent undocumented changes by Microsoft render WMM sometimes unable to handle this format (sadly it used to). This overrides the UseExtM3u setting when the Media Agent is MicroSoft Windows Media Player. This setting is documented for completeness, but you should not change it.

Default: true

CSSfile

Name of CSS file. If you rename YoDJ, it will look for an INI file by that name with INI as the extension. The CSS file still defaults to YoDJ.CSS, but you can overide this in the INI

Default: yodj.css

SendKeepAlive

MicroSoft Web Servers send an explicit Connection-Close and this interferes with sending inline files such as M3u files for playlists. This setting tells YoDJ! to send a Keep-Alive string in the header for the inline M3u file. The default is ON and causes no harm, but can be turned off.

Default: True



Notes Files Information

Notes files can be used to control folders and files. You can use them to add annotation to a folder or file and override the default behavior of a given folder or file. For example, I have folders playable defaulted to true, but my main music directory has more than 100 folders each of which contains several subfolders. If a user selected that huge folder to play, they might get a 1000 hour long playlist. This is probably not what the user expected.

The notes files are found in the directory in which the object is found. In other words, a folder note is found in its parent directory and a file note is found in its subdirectory

There are no real default values to the notes files, since the intent is to either provide a description for annotation or override the default value from the yodj.ini file. Use them only when you need them and only use the fields that make sense. If you want to add a description. Just use that one line. If you want to skip a file or directory, that is all you need to say.



Notes Configuration Files

skip

skip this file, pretend its not there, hide it.

Possible Values: true or false

Playable

file or folder can be played

Possible Values: true or false

Description

Description for file or folder

Possible Values: Whatever you want to say

hidename

Hide the filename. This will be ignored if you do not supply a description as an alternative.

Possible Values: Whatever you want to say

Sample Notes files:


Sample of Directory Note with play override (contents cannot be streamed)
Sample of Directory with a skip command (YoDJ Ignores it)
Sample of Directory Note with description
Back to Top
Last Modified  03/15/2010      Questions? email