Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
wizard: move .md texts to docs/wizard/*.md
  • Loading branch information
perexg committed Apr 4, 2016
1 parent c3fe801 commit 1e76316
Show file tree
Hide file tree
Showing 11 changed files with 207 additions and 163 deletions.
21 changes: 15 additions & 6 deletions Makefile
Expand Up @@ -541,11 +541,14 @@ ALL-$(CONFIG_DVBSCAN) += check_dvb_scan
# Documentation
#

SRCS-yes += src/docs.c
I18N-C += src/docs_inc.c
I18N-DOCS = $(wildcard docs/markdown/*.md) $(wildcard docs/class/*.md)
MD-ROOT = $(patsubst docs/markdown/%.md,%,$(wildcard docs/markdown/*.md))
MD-CLASS = $(patsubst docs/class/%.md,%,$(wildcard docs/class/*.md))
SRCS-yes += src/docs.c
I18N-C += src/docs_inc.c
I18N-DOCS = $(wildcard docs/markdown/*.md)
I18N-DOCS += $(wildcard docs/class/*.md)
I18N-DOCS += $(wildcard docs/wizard/*.md)
MD-ROOT = $(patsubst docs/markdown/%.md,%,$(wildcard docs/markdown/*.md))
MD-CLASS = $(patsubst docs/class/%.md,%,$(wildcard docs/class/*.md))
MD-WIZARD = $(patsubst docs/wizard/%.md,%,$(wildcard docs/wizard/*.md))

#
# Internationalization
Expand Down Expand Up @@ -676,6 +679,11 @@ $(BUILDDIR)/docs-timestamp: $(I18N-DOCS) support/doc/md_to_c.py
support/doc/md_to_c.py --in="docs/class/$${i}.md" \
--name="tvh_doc_$${i}_class" >> src/docs_inc.c || exit 1; \
done
@for i in $(MD-WIZARD); do \
echo "Markdown: docs/wizard/$${i}.md"; \
support/doc/md_to_c.py --in="docs/wizard/$${i}.md" \
--name="tvh_doc_wizard_$${i}" >> src/docs_inc.c || exit 1; \
done
@printf "\n\nconst struct tvh_doc_page tvh_doc_markdown_pages[] = {\n" >> src/docs_inc.c
@for i in $(MD-ROOT); do \
echo " { \"$${i}\", tvh_doc_root_$${i} }," >> src/docs_inc.c || exit 1; \
Expand All @@ -685,9 +693,10 @@ $(BUILDDIR)/docs-timestamp: $(I18N-DOCS) support/doc/md_to_c.py
@touch $@

src/docs_inc.c: $(BUILDDIR)/docs-timestamp

src/docs_inc.h: $(BUILDDIR)/docs-timestamp

$(BUILDDIR)/src/docs.o: src/docs_inc.c $(I18N-DOCS) support/doc/md_to_c.py
$(BUILDDIR)/src/docs.o: $(BUILDDIR)/docs-timestamp $(I18N-DOCS) support/doc/md_to_c.py

# Internationalization
.PHONY: intl
Expand Down
14 changes: 14 additions & 0 deletions docs/wizard/channels.md
@@ -0,0 +1,14 @@
You are now finished.

You may further customize your settings by editing channel numbers, etc.

If you confirm this dialog, the default administrator account will be
removed. Please then the use credentials you defined thru this wizard.

If you require further help, check out
[Tvheadend.org](http://tvheadend.org) or chat to us on
[IRC](https://kiwiirc.com/client/chat.freenode.net/?nick=tvhhelp|?#hts).


Thank you for using Tvheadend (and don't forget to
[donate](http://tvheadend.org/projects/tvheadend/wiki/Donate))! :)
11 changes: 11 additions & 0 deletions docs/wizard/channels2.md
@@ -0,0 +1,11 @@
You are now finished.

You may further customize your settings by editing channel numbers, etc.

If you require further help, check out
[Tvheadend.org](http://tvheadend.org) or chat to us on
[IRC](https://kiwiirc.com/client/chat.freenode.net/?nick=tvhhelp|?#hts).


Thank you for using Tvheadend (and don't forget to
[donate](http://tvheadend.org/projects/tvheadend/wiki/Donate))! :)
24 changes: 24 additions & 0 deletions docs/wizard/hello.md
@@ -0,0 +1,24 @@
Enter the access control details to secure your system. The first part
of this covers the network details for address-based access to
the system; for example, 192.168.1.0/24 to allow local access only
to 192.168.1.x clients, or 0.0.0.0/0 or empty value for access
from any system.


This works alongside the second part, which is a familiar username/password
combination, so provide these for both an administrator and regular
(day-to-day) user.


**Notes**:


* You may enter a comma-separated list of network prefixes (IPv4/IPv6).
If you were asked to enter a username and password during installation,
we'd recommend not using the same details for a user here as it may cause
unexpected behavior, incorrect permissions etc.
* To allow anonymous access for any account (administrative or regular user) enter
an asterisk (*) in the username and password fields. ___It is not___
recommended that you allow anonymous access to the admin account.
* If you plan on accessing Tvheadend over the Internet, make sure you use
strong credentials and ___do not allow anonymous access at all___.
24 changes: 24 additions & 0 deletions docs/wizard/login.md
@@ -0,0 +1,24 @@
Enter the access control details to secure your system.
The first part of this covers the network details
for address-based access to the system; for example,
192.168.1.0/24 to allow local access only to 192.168.1.x clients,
or 0.0.0.0/0 or empty value for access from any system.


This works alongside the second part, which is a familiar
username/password combination, so provide these for both
an administrator and regular (day-to-day) user.


**Notes**:


* You may enter a comma-separated list of network prefixes (IPv4/IPv6).
If you were asked to enter a username and password during installation,
we'd recommend not using the same details for a user here as it may cause
unexpected behavior, incorrect permissions etc.
* To allow anonymous access for any account (administrative or regular user) enter
an asterisk (*) in the username and password fields. ___It is not___
recommended that you allow anonymous access to the admin account.
* If you plan on accessing Tvheadend over the Internet, make sure you use
strong credentials and ___do not allow anonymous access at all___.
20 changes: 20 additions & 0 deletions docs/wizard/mapping.md
@@ -0,0 +1,20 @@
Map all discovered services to channels.


In order for your frontend client(s) (such as Kodi, Movian, and similar)
to see/play channels, you must first map discovered services to
channels.


If you would like Tvheadend to do this for you, check the
'Map all services' option below, but be aware that this will also map
encrypted services you may not have access to.


**You may omit this step (do not check 'Map all services') and
map services to channels manually.**


**Notes**:
* Many providers include undesirable services - Teleshopping, Adult
Entertainment, etc; using the 'Map all services' will include these.
17 changes: 17 additions & 0 deletions docs/wizard/muxes.md
@@ -0,0 +1,17 @@
Assign predefined muxes to networks. To save you from manually entering
muxes, Tvheadend includes predefined mux lists. Please select a list
for each network below.


**Notes**:


* Select the closest transmitter if using an antenna (T); if using
cable (C), select your provider; if using satellite (S), the orbital
position of the satellite your dish is pointing towards; or if using
IPTV, enter the URL to your playlist.
* If you're unsure as to which list(s) to select you may want to look
online for details about the various television reception choices
available in your area.
* Networks already configured will not be shown below.
* Selecting the wrong list may cause the scan (on the next page) to fail.
30 changes: 30 additions & 0 deletions docs/wizard/network.md
@@ -0,0 +1,30 @@
Now let's get your tuners configured. Go ahead and select a network for
each of the tuners you would like to use. if you do not assign a
network to a tuner it will __not__ be used.

**Selecting the Right Network**:


Many tuners are able to receive different signal types..

**If you receive your channels through an antenna (also known as an aerial)**
then you would select the network under the tuners with DVB-T/ATSC-T/ISDB-T
in the name.

**If you receive your channels through a satellite dish** then you would
select the network under the tuners with DVB-S/S2 in the name.

**If you receive your channels via cable** then you would select the
network under the tuners with DVB-C/ATSC-C/ISDB-C in the name.


**Notes**:


* Tuners already in use will not appear below.
* If using IPTV, the playlist you enter must contain valid links to
streams using codecs supported by Tvheadend.
* For devices with multiple tuners (e.g. either cable or terrestrial),
be aware that many only allow you to use one tuner at a time.
Selecting more than one tuner per device can thus result in unexpected
behavior.
18 changes: 18 additions & 0 deletions docs/wizard/status.md
@@ -0,0 +1,18 @@
Tvheadend is now scanning for available services. Please wait until the
scan completes..


**Notes**:


* During scanning, the number of muxes and services shown below should
increase. If this doesn't happen, check the connection(s) to your
device(s)..
* The status tab (behind this wizard) will display signal information.
If you notice a lot of errors or the signal strength appears low then
this usually indicates a physical issue with your antenna, satellite
dish or cable..
* If you don't see any signal information at all, but the number of
muxes or services is increasing anyway, the driver used by your device
isn't supplying signal information to Tvheadend. In most cases this
isn't an issue..

0 comments on commit 1e76316

Please sign in to comment.