Пишем Help

[PsychoStalker]

Предлагаю писать Help.
Заявляете плагины/пункты меню, которые хотите описать. (только если уверены, что сделаете это!!!!)
Дополняйте и поправляйте других.


<span style='font-size:13pt;line-height:100%'>Требуется написать</span>

1. Playback
2. О том, что такое foobar и чем он так хорош.
3. О том как подключать компоненты и, наверное, что это вообще такое.
4. О том ЧТО такое теги и какие они бывают. И почему foobar считает родными APEv2
5. Меню Playback
6. Меню Playlist
7. User Interface (Title Formating, ColunsUI, Looks)
8. Output (все существующие методы)
9. Album Art и все о нем.

Все должно быть описано подробно. Не стоит писать "два слова", если не знаете некоторых нюансов напишите об этом курсивом, отделив фразу с обоих сторон тремя восклицательными знаками.
Некоторые темы поставлены мной очень широко. Если хотите описать только какой-то элемент, я создам подпункты.
Можно ссылаться на другие разделы, даже они еще не написаны.
Побольше примеров.

------------------------------------------------------------------------------
<span style='font-size:13pt;line-height:100%'>Ogg Preview</span> (файл foo_oggpreview.dll)

Описание:
Плагин предназначен для создания preview альбомов. Его работа основана на том, что OGG по сути является не форматом, а контейнером. В него можно "положить" несколько звуковых файлов.
Итак, плагин сканирует песни для которых нужно создать preview, пережимает их в формат Vorbis и складывает все композиции в один файл. При этом остаются куски песен такой длительности, чтобы итоговый файл был заданого размера.
Для чего это нужно? Например, у вас есть своя группа. Вы выкладываете в интернет свои композции и небольшой preview-файл. Теперь каждый может скачать его и решить, что из ваших песен он будет качать и будет ли вообще.

Как пользоваться:
Выделить нужные песни, правой кнопкой / Create Ogg Preview

Настройки плагина:
File name format -- формат имени итогового файла. Можно использовать стандартный titleformat синтаксис foobar'а
Path for Files -- папка куда будут складываться итоговые файлы. Синтаксис использовать нельзя.
Vorbis encoding quality -- качество сжатия, от -1 до 10. Стандартное качество для Vorbis равно 3, но, на самом деле, для Preview 0 достаточно.
Target Size\Lenght -- размер итогового файла. Size размер в Кбайтах всего итогового файла. Lenght длительность в секундах каждого трека.
Use ReplayGain -- использовать ли ReplayGain если соответствующие теги есть в исходном файле. (подробнее смотри ReplayGain scanner).
Copy all source tag to Ogg -- копировать ли все теги, которые есть в исходном файле, в preview.
Multialbum mode -- складывать каждый альбом (определяется по тегам) в новый файл. Настройки Target Size действуют на КАЖДЫЙ файл. Т.е. получится несколько файлов, каждый размером с указаным в настройках.

--------------------------------------------------------------------

<span style='font-size:13pt;line-height:100%'>Core</span> -- настройки ядра

Resume playback after restart -- если при закрытии foobar'а он играл, то при запуске он будет играть ту же песню. (Здесь баг, если фубар закрыт не через "крестик", например, при выключении компьютера, то это не работает).
Start playing on startup -- foobar начинает играть сразу после запуска, независимо от состояния при закрытии.
Enable user profile support -- !!!насколько я понимаю, работает только в NT системах (NT, 2000, XP, Longhorn <!--emo&:)-->[img]style_emoticons/<#EMO_DIR#>/smile.gif[/img]<!--endemo--> )!!! настройки запоминаются отдельно для каждого Юзера в системе. Хранятся в папке "%USERPROFILE%\Application Data\Foobar2000" Зачастую что-то типа "C:\Documents and Settings\Имя пользователя\Application Data\Foobar2000"
Sort incoming files by: как сортировать файлы по умолчанию. Можно использовать стандартный titleformat синтаксис foobar'а. Например

Код: выделить все

%artist%|%album%|%tracknumber%

сортирует по исполнителю, внутри исполнителя по альбомам, а внутри альбомов по номерам треков. Рекомендуется использование операторов $if() если теги проставлены не во всех файлах.

!!! может кто-нибудь понятно напишет большую статью, что такое теги, какие они бывают, и почему ID3v2 мастдай а APEv2 рулез? !!!

Restrict incoming files to -- принимать только файлы соответствующие шаблону. Например, если у вас в коллекции нет никаких файлов кроме mp3, то можете с чистой совестью написать там *.mp3. Теперь в плейлист НИКАК не попадут всякие там cover.jpg

Reset stop-after-current after stopping -- отключать stop-after-current после нажатия на Stop (подробнее см. меню Playback)
Change selection when "Playback / Follow cursor" is enabled -- очень странно работающая функция. Практика показывает, что лучше её включить...
Enable default multimedia keyboard support -- включить стандартное взаимодействие с мультимедийными клавишами. Независимо от клавиш, настраиваемых в "Keyboard Shortcuts". Т.е., если эта опция выключена, а клавиши настроены, они все равно работать будут.
Stop plaing on file open errors -- останавливать проигрывание при ошибках открытия файлов. Предположим у вас есть плейлист. Одну песню стираете, как только Foobar на неё натыкается, он остановится, если опция включена, если выключена -- будет играть следующую.
DDE support enabled -- включение DDE. !!! А это что за покемон?!?!?!? !!!
Process Priority class -- приоритет Foobar'а как процесса. Если слушаете музыку параллельно с другими программами и играми, то ставьте High (не относится к очень производительным системам). Внимание! Не ставьте Realtime никогда, если foobar зависнет в таком положении, то перезагрузка только через Reset (это относиться ко всем программам).

24.01.05 Дополнил Core указанными форумчанами замечаниями.

[PsychoStalker]

Вот еще написал <!--emo&:)-->[img]style_emoticons/<#EMO_DIR#>/smile.gif[/img]<!--endemo-->
Не забываем также исправлять ошибки.


<span style='font-size:13pt;line-height:100%'>Database</span> (встроенная база данных)

Описание:
Фубар имеет встроенную базу данных, в которой сохраняет файлы и информацию о них (в основном теги).
Нужна она для нескольких вещей:
1. Если она включена, то при следующем открытии файлов, foobar будет читать теги не из файлов, а из базы данных, что существенно быстрее.
2. Если не хочется хранить ту или иную информацию о файле в нем самом, то можно хранить её в базе данных. Кроме того, здесь же хранится информация об AudioCD.
3. С помощью некоторых плагинов (Album List, Album List Panel, DBExplorer), можно использовать её, как каталог музыки.

Использование и настройки:
Database enabled -- включить. Разумеется, для всего нижеописанного эта галочка необходима.
Restrict directories to: -- добавлять информацию только из следующих директорий. Для того, чтобы в базу не попадали всякие "левые" файлы можно прописать ту директорию в которой у вас лежит музыка и, по желанию, путь к CD-Rom.
Restrict file types: -- принимать только файлы соответствующие маске. Маски перечисляются через точку с запятой. Символ * означает любую последовательность символов.

Вышеперечисленные настройки вступают в силу только после перезапуска Foobar.

Итак, теперь все файлы открываемые в Foobar и отвечающие требованиям масок попадут в базу данных. Кроме того, можно сразу нажать кнопочку "Scan" и директории определенные в "Restrict directories to" буду просканированы на предмет файлов определенных в "Restrict file types:". В базу попадут только те файлы, которые Foobar понимает. Т.е. при любых настройках, всякие jpg, txt и пр. в базу не попадут, здесь можно не беспокоиться.

Remove dead entries from database -- убрать из базы несуществующие файлы. Если почистили свою музыку, то рекомендуется нажать эту кнопочку. Внимание! Сначала следует убрать эти треки из всех открытых плейлистов, потому, что иначе, при следующем запуске, треки снова будут в базе.
Nuke database -- Удалить всю базу при следующем запуске. Внимание! Не забудьте удалить все открытые Playlist'ы по вышеописаной причине.
Block tag update operations -- все изменения тегов, делаемые Foobar'ом будут сохраняться ТОЛЬКО в базе. Сами файлы меняться никак не будут. В будущем планируется сделать возможность выбора, какие теги сохранять, а какие нет.

Меню по правой кнопке на имени трека:
Reload info from file(s) -- загрузить информацию из выделенных файлов в базу заново
Reload info from file(s) if changed -- загрузить информацию из выделенных файлов в базу заново, только если файлы менялись. В целом, быстрее, чем предыдущий пункт.
Rewrite file tags from database -- записать в выделенные файлы всю информацию содержащуюся в базе.
Remove tags from file(s) -- удалить все теги из выделенных файлов.
Remove file(s) from database -- удалить из базы информацию о выделеных файлах.

------------------------------------------------------------

<span style='font-size:13pt;line-height:100%'>Album List</span> (файл foo_albumlist.dll)

Описание:
Визуальное настраиваемое представление базы данных. По сути каталог музыки.

Как пользоваться:
Разумеется, база данных должна быть включена, а музыка просканирована.
Выбираем в главном меню Components\Album List
Видим древовидную структуру, сортировку можно настраивать и выбирать из готовых пресетов в меню "View". Любой пункт можем отправить в текущий плейлист или добавить в него. Кроме того, в зависимости от настройки (см.ниже) можем добавить в новый плейлист с именем идентичным добавляемому пункту.

Настройки плагина:
Views -- пресеты сортировки. Можно добавлять свои с помощью кнопки "Add New". Формат стандартный titleformat, каждый пункт через символ "|". С помощью кнопки "Reset" можно сбросить настройки на страндартные.

Double-click action: -- событие по двойному клику на пункте
Middle button action: -- событие по клику средней кнопкой на пункте

Код: выделить все

[b]Перевод событий[/b]
   Expand/Collapse -- развернуть/свернуть подпункт
   Send to playlist -- отправить в текущий плейлист (все, что было до этого удаляется)
   Add to playlist -- Добавить в текущий плейлист (в конец плейлиста)
   Send to new playlist -- отправить в новый плейлист (имя плейлиста берется из имени отправляемого пункта).

Start playback when sending to playlist -- начинать воспороизведение сразу после добавления в плейлист
Show sub-item counts -- показывать количество подпунктов.
Show item counts -- проставлять порядковый номер пунктов, внутри данного пункта.

Font -- можно настроить шрифт, используемый при отображении дерева.

Use custom sorting for tree items: !!! Я так понимаю, атавизм. После введения меню View уже не нужен. !!!

Примечание: View...by directory structure является самым быстрым способом отображения, кроме того, так гарантированно в AlbumList попадут все файлы, иначе, файлы не имеющие тех или иных тегов, могут не отображаться.

(22.01.2005 поправил ошибки в описании Show item counts и Show sub-item counts)

[Anthony Fox]

Сразу, простите за оффтоп.
<!--QuoteBegin--><div class='quotetop'>QUOTE</div><div class='quotemain'><!--QuoteEBegin-->Core -- настройки ядра
Resume playback after restart -- если при закрытии foobar'а он играл, то при запуске он будет играть ту же песню. (Здесь баг, если фубар закрыт не через "крестик", например, при выключении компьютера, то это не работает).<!--QuoteEnd--></div><!--QuoteEEnd-->
Более того, если фубар закрывается не через крестик все функции-элементы on_systemshutdown (если система завершает работу) и on_quit (вроде они так называются) каждого плагина (если эти функции есть) не выполняются (хотя должны). Надо бы сообщить об этом глюке автору. Глюк появился в версии 0.8.3. В 0.8.2 такого вроде не было.

Насчет Help'а: нужно будет сообрать это все потом в *.chm-файл.

[PsychoStalker]

<!--QuoteBegin-Anthony Fox+Jan 16 2005, 18:19--><div class='quotetop'>QUOTE(Anthony Fox @ Jan 16 2005, 18:19)</div><div class='quotemain'><!--QuoteEBegin-->Насчет Help'а: нужно будет сообрать это все потом в *.chm-файл.
[right][snapback]160302[/snapback][/right]
<!--QuoteEnd--></div><!--QuoteEEnd-->
Ага... Я так и думал. И чтобы дерево повторяло дерево настроек.

2 All
Это только полдела.
Надо еще писать конкретные HowTo.
Т.е. что надо делать, например, чтобы Фубар показывал обложки.
Начиная с того, что надо скачивать и заканчивая вариантами строк поиска.
Причем описать все возможные пути (в данном случе два -- через looks и через панель).

<!--QuoteBegin-Anthony Fox+Jan 16 2005, 18:19--><div class='quotetop'>QUOTE(Anthony Fox @ Jan 16 2005, 18:19)</div><div class='quotemain'><!--QuoteEBegin-->Глюк появился в версии 0.8.3. В 0.8.2 такого вроде не было
[right][snapback]160302[/snapback][/right]
<!--QuoteEnd--></div><!--QuoteEEnd-->
Думаю, если ко времени сборки глюк не исправят, то в хелп надо обязательно внести.
Или отдельный раздел сделать "Известные баги ядра и плагинов".

[Shelix]

2PsychoStalker
Респект! Обещаю присоединиться после сессии. Чувствую необходим координатор, если будут еще желающие помочь. Возьмешься?
Необходимо собрать запросы, что необходимо еще написать и координировать работу, чтобы два человека одновременно не писали одно и то же.

[PsychoStalker]

<!--QuoteBegin-Shelix+Jan 22 2005, 15:37--><div class='quotetop'>QUOTE(Shelix @ Jan 22 2005, 15:37)</div><div class='quotemain'><!--QuoteEBegin-->Возьмешься?
Необходимо собрать запросы, что необходимо еще написать и координировать работу, чтобы два человека одновременно не писали одно и то же.
[right][snapback]161248[/snapback][/right]
<!--QuoteEnd--></div><!--QuoteEEnd-->
Да, в принципе, без проблем.
Только технология несколько не ясна.
Пока думаю будет достаточно, если каждый будет скидывать прямо сюда, что ему надо, и что он пишет.
Для затравки, я опишу freedb. (возможно, даже прямо сегодня).
На самом деле я бы все описал, но не все знаю! бывает, что все настройки плагина понятны, а парочка вообще ноль...
Буду выкладывать с пустыми местами и пометками курсивом, что не написал, кто сможет напишет...

К сожалению, ажиотажа пока не видно

[Splinter_x86]

Чем смогу помогу, вот тока сессию добью и примусь за дело

[Shelix]

<!--QuoteBegin-PsychoStalker+Jan 22 2005, 14:24--><div class='quotetop'>QUOTE(PsychoStalker @ Jan 22 2005, 14:24)</div><div class='quotemain'><!--QuoteEBegin-->Да, в принципе, без проблем.
Только технология несколько не ясна.
[right][snapback]161252[/snapback][/right]
<!--QuoteEnd--></div><!--QuoteEEnd-->
Вот и хорошо. Я себе технологию представляю примерно так. Ты ведешь список "требуется написать". Каждый желающий помочь, выбирает тему, которую знает, пишет статью и выкладывает сюда "на суд зрителей". В конце собираешь общий *.chm файл.
Предлагаю в итоговом хелпе в каждой статье подписывать автора.
И еще, плагины постоянно обновляются и появляются новые, так что работа потенциально бесконечная

[Splinter_x86]

Написал справку по параметрам коммандной строки:

<span style='font-size:14pt;line-height:100%'>Параметры Коммандной Строки</span>
Использование: C:\Program files\Foobar2000\foobar2000.exe /<комманда>
Доступные параметры коммандной строки:
/help - краткая справка
/add - добавить файлы в плейлист
/play - играть
/pause - временно приостановить проигрывание
/playpause - если играет то поставить на паузу, и наоборот
/prev - предыдущий трек
/next - следующий трек
/rand - проиграть произвольный трек
/stop - остановить
/exit - закрыть плеер
/show - показать окно плеера, если свернут
/hide - свернуть
/config - открыть окно с настройками
/comand:<menu command> - выполнить внутреннюю команду
//например: c:\program files\foobar2000\foobar2000.exe /command:"Playback/Volume mute" - Выключает звук плеера
//Для того чтобы просмотреть доступные комманды откройте: "Preferences/Core/Main menu items" правый клик на "[group]Foobar2000/Insert item/Command/" в открывшаемся окне можно просмотреть все доступные комманды.
/playlist_command:<context menu command> - выполнить комманду из контекстного меню в плейлисте с выделенными треками
//например: c:\program files\foobar2000\foobar2000.exe /playlist_command:"Properties" -окрывает окно "File info" у выделенных треков
/playing_command:<context menu command> - выполнить комманду из контекстного меню с проигрывающимся треком в плейлисте
//например: c:\program files\foobar2000\foobar2000.exe /playing_command:"Properties" - открывает окно "File info" у проигрывающегося трека

<span style='color: #999999'>Добавлено([mergetime]1106490699[/mergetime]):</span>
<span style='font-size:14pt;line-height:100%'>Display</span>
-User interface Module
User Interface Module - Выбрать модуль пользовательского интерфейса.
Настройки вступают в силу после перезапуска плеера.


-Playlist Search
Настройки окна поиска в плейлисте появляющегося при нажатии кнопки F3.
Limit results to - ограничивает количество результатов поиска
Fields to scan - Поля которые будут сканироваться при поиске
//например: artist;album;title;filename - при запросе будут сканироваться
теги - artist;album;title и filename - и название файла
Font - шрифт в окне поиска
-Show dynamic info (playback status, dynamic bitrate, HTTP track titles,
etc) in playlist - Показывать динамическую информацию в плейлисте (статус проигрывания, переменный битрейт, !!!HTTP track titles!!! кто знает что это напишите, т.к. я этим не пользуюсь)
статус проигрывания - например можно использовать чередование символов рядом с проигрываемым треком
переменный битрейт - для отображения используйте тег в титле форматинге %__bitrate_dynamic% и не забудьте поставить галочку в "Preferences/Playback/Input/Standart Inputs" напротив Real time bitrate for VBR files.
Properties window font - Шрифт в окне "File info"
Remember window positions - запоминать позицию окна плеера

!!! Double-width characters in title formatting - способ отображения символов двойной ширины в титле форматинге !!!
Кто знает опишите подробней этот пункт.

[Splinter_x86]

2PsychoStalker
<!--QuoteBegin--><div class='quotetop'>QUOTE</div><div class='quotemain'><!--QuoteEBegin-->Enable user profile support -- !!!насколько я понимаю, работает только в NT системах (NT, 2000, XP, Longhorn smile.gif )!!! настройки запоминаются отдельно для каждого Юзера в системе.<!--QuoteEnd--></div><!--QuoteEEnd-->
Допиши, что настройки хранятся в x:\Documents and Settings\%USERPROFILE%\Application Data\Foobar2000

<!--QuoteBegin--><div class='quotetop'>QUOTE</div><div class='quotemain'><!--QuoteEBegin-->Process Priority class -- приоритет Foobar'а как процесса. Если слушаете музыку параллельно с другими программами и играми, то ставьте High. Внимание! Не ставьте Realtime никогда, если foobar зависнет в таком положении, то перезагрузка только через Reset (это относиться ко всем программам).<!--QuoteEnd--></div><!--QuoteEEnd-->
Почему нужно ставить приоритет High, по мне и Normal не плохо?

<!--QuoteBegin--><div class='quotetop'>QUOTE</div><div class='quotemain'><!--QuoteEBegin-->Насчет Help'а: нужно будет сообрать это все потом в *.chm-файл.<!--QuoteEnd--></div><!--QuoteEEnd-->
Лучше сделать все в html с фреймом, меньшая зависимость от IE и Windows'a. К тому же официальный фак и help в html'e. Ну и наконец html кроссплатформенный стандарт. Дизайн нашей справки, нужно сделать в соотвествии с офиц. факом

[Shelix]

<!--QuoteBegin-Splinter_x86+Jan 23 2005, 18:43--><div class='quotetop'>QUOTE(Splinter_x86 @ Jan 23 2005, 18:43)</div><div class='quotemain'><!--QuoteEBegin-->Лучше сделать все в html с фреймом, меньшая зависимость от IE и Windows'a. К тому же официальный фак и help в html'e. Ну и наконец html кроссплатформенный стандарт. Дизайн нашей справки, нужно сделать в соотвествии с офиц. факом
[right][snapback]161334[/snapback][/right]
<!--QuoteEnd--></div><!--QuoteEEnd-->
Насколько я знаю, автор не собирается переносить foobar на другие платформы, отличные от виндов. Так что излишне стремиться к кроссплатформенности хелпа, думаю линуксоидам он ни к чему. Мне просто субъективно нравится организация информации в chm-ках, можно сделать и так и так.

[Lynn]

<!--QuoteBegin--><div class='quotetop'>QUOTE</div><div class='quotemain'><!--QuoteEBegin-->Допиши, что настройки хранятся в x:\Documents and Settings\%USERPROFILE%\Application Data\Foobar2000<!--QuoteEnd--></div><!--QuoteEEnd-->
Только без x:\Documents and Settings\. В %UserProfile% входит полный путь до профиля пользователя, да и не всегда он C:\Documents and Settings. У меня, например, это C:\Users.
<!--QuoteBegin--><div class='quotetop'>QUOTE</div><div class='quotemain'><!--QuoteEBegin-->Почему нужно ставить приоритет High, по мне и Normal не плохо?<!--QuoteEnd--></div><!--QuoteEEnd-->
Думаю, это зависит от производительности компа.

[PsychoStalker]

<!--QuoteBegin-Splinter_x86+Jan 23 2005, 20:31--><div class='quotetop'>QUOTE(Splinter_x86 @ Jan 23 2005, 20:31)</div><div class='quotemain'><!--QuoteEBegin-->HTTP track titles
[right][snapback]161332[/snapback][/right]
<!--QuoteEnd--></div><!--QuoteEEnd-->
Читать теги при проигрывании через http. Хотя точно не уверен...

<!--QuoteBegin-Splinter_x86+Jan 23 2005, 20:31--><div class='quotetop'>QUOTE(Splinter_x86 @ Jan 23 2005, 20:31)</div><div class='quotemain'><!--QuoteEBegin-->%__bitrate_dynamic%
[right][snapback]161332[/snapback][/right]
<!--QuoteEnd--></div><!--QuoteEEnd-->
А вот у меня не работает <!--emo&:(-->[img]style_emoticons/<#EMO_DIR#>/sad.gif[/img]<!--endemo--> Почему?
Я в статусбаре пробую.
..
Хех, сам на гидрогене нашел
"Preferences - Playback - Input - Standard Inputs - Check: Real-time bitrate display..."

Splinter_x86, добавь туда же в скобочках. Думаю люди будут натыкаться.

[Spike]

Камрады, у меня как напряга с траффиком кончиться к 1му числу, я присоединюсь

[yandexx]

Вместо предложенной формы написания хелпа гораздо лучше будет создать сайт, а на нем Wiki. Это позволит редактировать хелп любому, кто захочет и в любое время. А иначе этот тред может вырасти во что-то невменяемое..
Пример WIKI - <a href='http://wikipedia.org/' target='_blank'>http://wikipedia.org/</a>
Осталось найти организатора и хостера.