Documentation in Readme file

I will try to work on the Readme file.

EnjoyLife,

Whatever documentation you are able to come up with with be a HUGE help and very much appreciated. If you send me the readme, I will include it in the module giving you "commit" attribution for that addition, which will show up in your profile.

Thanks again,

Travis.

I have added information to the Readme file. However, I'm still working on the Installation section. Would it be best to simply redirect people to the guides online, or are basic instructions in the Readme file also helpful?

I'm unclear on what was meant by "Presets create css files in your public files directory/css/osmplayer/presetname/."

(Sorry, I have been very busy this past month.)

I have done some work on the documentation for MediaFront. I think in the readme file, it is best to have basic information about MediaFront with links to further resources. In a separate file or in online documentation, more information can be given about how to install and configure MediaFront. MediaFront is complex and there are multiple ways it can be implemented. Therefore, I think a separate file from the readme would be less confusing to a MediaFront beginner.

I am attaching two separate files. One is a readme file which includes basic information about MediaFront.

The second is a skeleton of an installation and configuration guide. This file will include instructions for installing and configuring the MediaFront module. Different sections will explain different configurations and settings.

I'd appreciate input. Is there a section that is missing in either document? Would you like to contribute to a particular section?

Would a txt file in each new MediaFront release be the best way to present configuration documentation? Or would an editable page on drupal.org be more appropriate? Or is it best to add to and edit the pre-existing documentation on mediafront.org?

Thanks for your help and input.

EnjoyLife,

This is definitely a great start! I will certainly commit this once we work out some of the details. I will try and spend some time tomorrow to fill out some of the questions you had within these files and get it committed soon. I will also give you commit attribution so you will see it within your Drupal.org profile.

Needless to say, I am very grateful for this work you have done, and keep it coming!

Travis.

Once the kinks are figured out for 7.x-2.x, I am willing to help with written documentation.

Elizabeth

I'm working on written documentation this week for the 2.x release and should have something over the weekend.

I'm still working on this and hope to add information concerning configuring Views today. It's a start.

From a first glance, I will just say that this is amazing! I went ahead and committed this last file to the DEV version of MediaFront. It will be included in the next release (after 2.0-alpha3). Thanks again for this amazing work!

Travis.

I used the April 23 dev release and made more edits to the readme file. This file includes details on how to configure Views with MediaFront 2.x and covers the three different configurations shown in the 2.x intro and walkthrough video.

This is an updated README file. This is a complete replacement for the current 7.x.-2.x-dev README.txt.

Changes made:
- Updated file to better conform with Drupal documentation standards. Lines are no longer than 80 characters and have unix line breaks. This should make the file easier to read.
- File has been cleaned up. Comments about changes that need to be made have been removed. Sections that still need to be updated notify the user that documentation is forthcoming and note the items that still need to be added to a section to make it complete.
- File has been thoroughly checked for grammatical and spelling errors.

The hope is that this file will serve as a refined README.txt good enough for the stable release of 2.x.

I don't understand how to use git, so this is a txt.

A note should be added to this for streaming video (Youtube in particular).

When setting up a view / playlist, only add the video field once and assign it as media > media content. If you add it again to assign it as the image type, it will break the view. The system will automatically use the media information provided by media_youtube to render the thumbnail without needing to assign it.

Assigning as release blocker so that this is pulled into the main release.

Elizabeth,

I just committed your latest README.txt into the module (with attribution), and also updated the module homepage to direct people to this file for documentation.

Thanks!

Travis.

The instructions for setting up a playlist for a node and for a view are the same, except for the instruction about the playlist. To streamline the instructions, I suggest:

CREATING AND CONFIGURING MEDIAFRONT PRESETS
-------------------------------------------

   1. Go to Structure > MediaFront Presets > Add Preset.
   2. Select Name, Description (optional) and Media Player. Click Next.
   3. You may change any settings here to affect how the player is displayed.
      At a minimum, if you are creating a player to be displayed in a node,
      go to Preset Settings > Player Settings > Playlist Settings> Display
      Settings and select Disable Playlist. For a player that will be displayed
      in a view, you will probably want to enable Show Playlist and disable
      Playlist Only. When you save the preset, the preview will update.

USING A PLAYER IN A NODE
-----------------------

   1. Go to Structure > Content types > <type> > Manage Display. Change the
      format for your media field to MediaFront Player.
   2. Click the gear to edit the MediaFront Presets settings. Select your preset,
     then click Update and click Save.

    - A note on fields:
      For each content type that will use MediaFront, you must be explicit with
      every field you want to display in MediaFront. The title is automatically
      brought in. If you click on edit on any other field, there is a section
      called MediaFront settings which will determine how a file or field is
      used and displayed in MediaFront.

Thanks for your input, mrtoner. I'll look into incorporating this.

Elizabeth

Thanks, jaymallison and mrtoner for your help. I've added some documentation pages at http://drupal.org/node/1563486. Please feel free to edit these pages.

Is there any documentation for the player to player feature? I'm having some trouble getting it to work and I assume it's just a missed setting.

Hmm, I couldn't get it to work following the readme. I had to add an additional field to the content type to get it to work. I added a field and called it [Node Media Player] and, set the field type to 'Media Player' with a widget of 'Media Player'. In the manage display, I had to set the Node Media Player format to a preset that I had already setup. This was the original way to setup a mediafront players for node players. Is it different now?

@rwilson0429: It is different now. I'd point you to the documentation (link above), but the examples given are just that: examples. They make some assumptions that may be different in your setup. Here's what you need to do, though:

1. Create your preset.
2. If you've not already got one, add a file field to your content type.
3. On the Manage Fields tab for your content type (or as you're adding the fields), edit -- at a minimum -- the File field. Tell MediaFront how to handle that particular field. Each field can be the title (this will override MediaFront's automatic selection of the node title), image, media (the content that will be played in the player), or a custom field that will be passed to a playlist (requires a custom template). Save the field.
4. On the Manage Display tab for your content type, set your File field's format to MediaFront Player.
5. Before you save the formats, click the gear icon for the File field and select your preset for this field. Click Update and Save the formats.

@mrtoner. Thanks a bunch, will give it a shot.

mrtoner, there is not any documentation yet regarding the player to player feature. Sorry I can't be of more help.

Thanks, Elizabeth. I'm having some trouble getting it to work and thought maybe I had just configured it incorrectly.