Difference between revisions of "User Manual:About"

From MythTV Official Wiki
Jump to: navigation, search
(Reading suggestions)
(Remove note)
 
(15 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{NavigateFirst|User Manual:Index|User_Manual:Introduction}}
+
{{User Manual TOC}}
 +
{{UpToDate 0.27}}
 +
== User Manual ==
  
== About this manual ==
+
=== About the User Manual ===
[[Image:RecordingPlaylistOptions.jpg|250px|right]]
+
This manual describes MythTV without using too many technical terms. The focus of the User Manual is primarily to explain how to use a working MythTV installation to record and view programs and how to tune, tweak and configure it. The process of building and updating it is covered in other places on the wiki.
+
  
Like the program itself, this manual is being produced by the community — the people who create and use the system — so its tone and depth of detail may vary in spots. It is my hope to be able to even out those hills and valleys a bit in the editing process without offending the people. I've also tried, before releasing this section for general consumption, and with the help of [[JDonavan]], to get some framework in place to serve as an example for later writers. A certain amount of structural coherence is a wonderful thing, and hopefully, folks will feel that my approach is comprehensible rather than compost. :-)
+
This manual explains how to use a working MythTV installation to record and view programs and how to tune, tweak and configure it. At high level it explains how to get going with simple non-technical language. You can also drill deeper into more advanced topics.
  
 +
Like the program itself, this manual is being produced by the community — the people who create and use the system — so its tone and depth of detail may vary in spots. I hope to even out those hills and valleys a bit in the editing process without offending the people. I've also tried, before releasing this section for general consumption, and with the help of [[Abandoned_User_Pages#JDonavan|JDonavan]], to get some framework in place to serve as an example for later writers. Structural coherence is worthwhile; I hope folks will feel that my approach is comprehensible rather than compost.  :-)
  
== Reading suggestions ==
+
The User Manual should, by policy, always reflect the system's '''current production release'''. The current  release is {{CurrentRelease}}. When we are preparing a new version the manual may be updated ahead of the release date. New features that apply as from a specific version will be identified as follows:
--> ''Read this paragraph to know when you can skip chapters or paragraphs''
+
  
Of course the best thing you can do is reading this manual from A to Z and back. But some people are in a hurry and for them there is this quickstartguide. Here will be explained how to use this manual to setup your MythTV system reading as few as possible paragraphs. This is possible by helping you to find the right paragraphs for your specific requirements/setup.
+
{{VersionNote|0.28|VBox support was added in 0.28}}
  
Right below some chapters and paragraphs you'll find reading notes giving you suggestions in which cases you need to read that chapter or paragraph. You can recognize this by the arrow followed by a suggestion showed in cursive style (e.g. see the one below the current paragraph name).  
+
This can be identified at the top of a page or section if there is a major new feature, or inline when there is a minor enhancement. If a feature is identified as being available in a version that is higher than the current release it will only be available to those who compile and install the unstable pre-release version. We want to stay as current as possible, but we don't want to leave large numbers of users behind. As we expand this manual, some of the more technical bits in that explanation will likely turn into hotlinks.
  
:--> ''This is a reading suggestion''
+
At the top of many pages there is a notation which will confirm the version to which a page has been updated, highlighted with a "Software Update" Icon [[File:Software-update-available.png|25px]]. If you find pages that are out of date, you are invited to bring them up to date.
  
Such a reading suggestion always has the same scope as the chapter or paragraph itself.
+
=== Editing the User Manual ===
  
==Notes about editing this manual ==
+
There are guidelines for editing the manual pages at the [[Manual of Style]]. For help with general wiki editing and formatting see [[Help:Editing]]. If you need more detailed help with editing see https://www.mediawiki.org/wiki/Help:Formatting and other pages on [https://www.mediawiki.org mediawiki].
The User Manual should, by policy, always reflect the system's '''current production release'''. MythTV 0.21 was released on 8 Mar 2008. When possible, differences regarding the immediately previous release should be noted in parentheses, or with numbered section headers if the changes are large enough. We want to stay as current as possible, but we don't want to leave large numbers of users behind. As we expand this manual, some of the more technical bits in that explanation will likely turn into hotlinks.
+
  
And so, on with the fun... :-)
+
[[Category:Introduction|1100]]

Latest revision as of 19:39, 4 November 2015

Software-update-available.png This page is up-to-date as of MythTV version 0.27.6, the current release is 29.0

User Manual

About the User Manual

This manual explains how to use a working MythTV installation to record and view programs and how to tune, tweak and configure it. At high level it explains how to get going with simple non-technical language. You can also drill deeper into more advanced topics.

Like the program itself, this manual is being produced by the community — the people who create and use the system — so its tone and depth of detail may vary in spots. I hope to even out those hills and valleys a bit in the editing process without offending the people. I've also tried, before releasing this section for general consumption, and with the help of JDonavan, to get some framework in place to serve as an example for later writers. Structural coherence is worthwhile; I hope folks will feel that my approach is comprehensible rather than compost.  :-)

The User Manual should, by policy, always reflect the system's current production release. The current release is 29.0. When we are preparing a new version the manual may be updated ahead of the release date. New features that apply as from a specific version will be identified as follows:

Version:
0.28
VBox support was added in 0.28

This can be identified at the top of a page or section if there is a major new feature, or inline when there is a minor enhancement. If a feature is identified as being available in a version that is higher than the current release it will only be available to those who compile and install the unstable pre-release version. We want to stay as current as possible, but we don't want to leave large numbers of users behind. As we expand this manual, some of the more technical bits in that explanation will likely turn into hotlinks.

At the top of many pages there is a notation which will confirm the version to which a page has been updated, highlighted with a "Software Update" Icon Software-update-available.png. If you find pages that are out of date, you are invited to bring them up to date.

Editing the User Manual

There are guidelines for editing the manual pages at the Manual of Style. For help with general wiki editing and formatting see Help:Editing. If you need more detailed help with editing see https://www.mediawiki.org/wiki/Help:Formatting and other pages on mediawiki.