From 80c990d2b8083e1c0b6cbbb6f14d25bbf2f7da72 Mon Sep 17 00:00:00 2001 From: Mark Clarkstone Date: Wed, 11 May 2016 10:58:25 +0100 Subject: [PATCH] mdhelp: update doc_update file mdhelp: hide long item properties mdhelp: update cribsheet --- docs/markdown/doc_update.md | 60 ++++------------------------- docs/markdown/markdown_cribsheet.md | 23 +++++++++++ src/input/mpegts/mpegts_network.c | 4 +- src/input/mpegts/mpegts_service.c | 2 +- 4 files changed, 34 insertions(+), 55 deletions(-) diff --git a/docs/markdown/doc_update.md b/docs/markdown/doc_update.md index 5c986d9a4..887552cb9 100644 --- a/docs/markdown/doc_update.md +++ b/docs/markdown/doc_update.md @@ -1,8 +1,10 @@ -##Updating the Documentation 5 April 2016 +##Updating the Documentation + +This information was last updated on 11 May 2016. The documentation is written in markdown, and then converted for direct inclusion to tvheadend binary. The markdown processor in -tvheadend binary adds also other information from the internal +tvheadend binary adds other information from the internal class system. The User Guide @@ -10,56 +12,10 @@ in [documentatation repository](https://github.com/tvheadend/tvheadend-documenta fetches the markdown files using the build-in web server and use them as source for mkdocs. -####Instructions for on-line help - -Change markdown files in docs/markdown, docs/classes, docs/wizard and type -make. Follow -[development page](https://tvheadend.org/projects/tvheadend/wiki/Development). - -####Instructions for User Guide (FIXME!) - -Broadly: - -1. Install dependencies ([mkdocs](http://www.mkdocs.org/) and -[git](https://help.github.com/articles/set-up-git/)) - -2. Clone the [documentation repository](https://github.com/tvheadend/tvheadend-documentation) - -3. Make changes locally. Pay close attention to formatting and syntax - -use the live reload function (`mkdocs serve`) to preview them. - -4. When you're happy, push the changes to your remote repository and open -a pull request - -> Because we upload the theme as well, what it looks like locally should be -> 100% representative of what it looks like once it's pushed to the Internet. - -Command sequence (this presumes Linux, but Windows is very similar): - -* `cd ~/tvheadend-documentation` -* `git add -A` (presumes to add everything, you can of course be selective) -* `git commit -m "Summary of changes"` -* `git push` - -... and then open the PR on github - -To update and resync, someone (me, probably!) needs to: - -1. Merge the changes -2. Pull the latest revisions from the repository -3. Convert the webui files: `./convert.sh docs/webui ` - -To merge the webui files into tvheadend, copy them into `/docs/html`, -push them to your remote repository and open a PR to merge them into master. +###Instructions For Built-in Help -4. Convert all files: `mkdocs build --clean` -5. Copy the contents of the resultant `site` directory to gihub pages +Change markdown files in `docs/markdown`, `docs/markdown/inc`, `docs/class`, `docs/wizard`, etc. +Images are placed in `src/webui/static/img/doc/`. -To publish the entire User Guide to gihub, use `resync.sh` or use the -following command sequence: +Build Tvheadend as you normally would, see the [development page](https://tvheadend.org/projects/tvheadend/wiki/Development) for details. -* `cd $YOUR_BASE_DIR/tvheadend.github.io` -* `cp -r $YOUR_BASE_DIR/tvheadend-documentation/site/* .` -* `git add -A` (presumes to add everything) -* `git commit -m "Resync"` (or whatever your commit message is) -* `git push` diff --git a/docs/markdown/markdown_cribsheet.md b/docs/markdown/markdown_cribsheet.md index 62e32d00a..b00ac840e 100644 --- a/docs/markdown/markdown_cribsheet.md +++ b/docs/markdown/markdown_cribsheet.md @@ -10,6 +10,29 @@ the cleaner the conversion, the less tidying up there is afterwards. * Markdown basics: [GitHub mastering markdown](https://guides.github.com/features/mastering-markdown) +###Including Documentation/Items + +You can include documentation/items in other markdown +files by using the tvh_class_doc, tvh_include and tvh_class_items tags. + +For example to include the passwd items you'd enter something like this: + +``` +passwd +``` + +To include class documentation you'd use: + +``` +passwd +``` + +To include multi-use docs (placed in the `docs/markdown/inc/` folder: + +``` +inc/common_button_table_end +``` + ###Paragraphs Versus Definition Lists Watch this one - indentation is key. diff --git a/src/input/mpegts/mpegts_network.c b/src/input/mpegts/mpegts_network.c index e500c938d..4f43968d6 100644 --- a/src/input/mpegts/mpegts_network.c +++ b/src/input/mpegts/mpegts_network.c @@ -241,7 +241,7 @@ const idclass_t mpegts_network_class = "(e.g. UTF-8)."), .off = offsetof(mpegts_network_t, mn_charset), .list = dvb_charset_enum, - .opts = PO_ADVANCED, + .opts = PO_ADVANCED | PO_DOC_NLIST, }, { .type = PT_INT, @@ -250,7 +250,7 @@ const idclass_t mpegts_network_class = .desc = N_("Select the time offset for EIT events."), .off = offsetof(mpegts_network_t, mn_localtime), .list = dvb_timezone_enum, - .opts = PO_EXPERT, + .opts = PO_EXPERT | PO_DOC_NLIST, }, { .type = PT_INT, diff --git a/src/input/mpegts/mpegts_service.c b/src/input/mpegts/mpegts_service.c index 3226d2852..18bdc4683 100644 --- a/src/input/mpegts/mpegts_service.c +++ b/src/input/mpegts/mpegts_service.c @@ -204,7 +204,7 @@ const idclass_t mpegts_service_class = .desc = N_("The character encoding for this service (e.g. UTF-8)."), .off = offsetof(mpegts_service_t, s_dvb_charset), .list = dvb_charset_enum, - .opts = PO_EXPERT, + .opts = PO_EXPERT | PO_DOC_NLIST, }, { .type = PT_U16, -- 2.47.3