fromfilename: docs/changelog (closes #113)

docs/changelog.rst

@@ -9,6 +9,8 @@ New stuff:
 * Add `Opus`_ audio support. Thanks to Rowan Lewis.
 * :doc:`/plugins/convert`: You can now transcode files to any audio format,
   rather than just MP3. Thanks again to Rowan Lewis.
+* The new :doc:`/plugins/fromfilename` guesses tags from the filenames during
+  import when metadata tags themselves are missing. Thanks to Jan-Erik Dahlin.
 
 And some fixes:
 

docs/guides/tagger.rst

@@ -51,14 +51,21 @@ all of these limitations.
   adjacent albums have a common prefix, followed by "disc," "disk," or "CD"
   and then a number, they are tagged together.
 
-* The music may have bad tags, but it's not completely untagged. (This is
-  actually not a hard-and-fast rule: using the *E* option described below, it's
-  entirely possible to search for a release to tag a given album.) This is
-  because beets by default infers tags based on existing metadata. The
-  :doc:`Acoustid plugin </plugins/chroma>` extends the autotagger to use
-  acoustic fingerprinting to find information for arbitrary audio. Install that
-  plugin if you're willing to spend a little more CPU power to get tags for
-  unidentified albums.
+* The music may have bad tags, but it's not completely untagged. This is
+  because beets by default infers tags based on existing metadata. But this is
+  not a hard and fast rule---there are a few ways to tag metadata-poor music:
+
+    * You can use the *E* option described below to search in MusicBrainz for
+      a specific album or song.
+    * The :doc:`Acoustid plugin </plugins/chroma>` extends the autotagger to
+      use acoustic fingerprinting to find information for arbitrary audio.
+      Install that plugin if you're willing to spend a little more CPU power
+      to get tags for unidentified albums. (But be aware that it does slow
+      down the process.)
+    * The :doc:`FromFilename plugin </plugins/fromfilename>` adds the ability
+      to guess tags from the filenames. Use this plugin if your tracks have
+      useful names (like "03 Call Me Maybe.mp3") but their tags don't reflect
+      that.
 
 * Currently, MP3, AAC, FLAC, ALAC, Ogg Vorbis, Monkey's Audio, WavPack,
   Musepack, Windows Media, and Opus files are supported. (Do you use some

docs/plugins/fromfilename.rst

@@ -0,0 +1,14 @@
+FromFilename Plugin
+===================
+
+The ``fromfilename`` plugin helps to tag albums that are missing tags
+altogether but where the filenames contain useful information like the artist
+and title.
+
+When you attempt to import a track that's missing a title, this plugin will
+look at the track's filename and guess its track number, title, and artist.
+These will be used to search in MusicBrainz and match track ordering.
+
+To use the plugin, just enable it by putting ``fromfilename`` on the
+``plugins:`` line in your config file. There are currently no configuration
+options.

docs/plugins/index.rst

@@ -67,6 +67,7 @@ disabled by default, but you can turn them on as described above.
    duplicates
    discogs
    beatport
+   fromfilename
 
 Autotagger Extensions
 ''''''''''''''''''''''
@@ -75,6 +76,8 @@ Autotagger Extensions
   missing or incorrect metadata.
 * :doc:`discogs`: Search for releases in the `Discogs`_ database.
 * :doc:`beatport`: Search for tracks and releases in the `Beatport`_ database.
+* :doc:`fromfilename`: Guess metadata for untagged tracks from their
+  filenames.
 
 .. _Beatport: http://www.beatport.com/
 .. _Discogs: http://www.discogs.com/