• 10 dec 2017: forum version update. In case of issues use this topic.
  • 30 nov 2017: pilight moved servers. In case of issues use this topic.
Hello There, Guest! Login Register


User manual
#11
Hmm, my approach is often to make a plan/outline of what is needed, generally in bullet point lists like this. It is easier for me to start working this way, thought I might share it here so that it's easier to start Smile
Basic brainstorm/outline that I came up with quickly, can be expanded:
  • Installation
  • Hardware setup (split it into basic sender+receiver and a separate page for setting up a filter?)
  • Configuring (split into several parts, possibly one for each section of the config file?)
  • How to use all the different pilight-* programs
  • Eventing (actions and operators, how to write rules)

And then making a list of the pages we actually need, sort of like this:
  • Installation - Stable
  • Installation - Nightly
  • Hardware - Sender + Receiver
  • Hardware - Filter, how to set up and flash
  • (Hardware - USB interface) - I don't know so much about this, but it seems to have potential, might be good to have a manual for it too
  • Configuration - Devices
  • Configuration - Rules
  • Configuration - GUI
  • Configuration - Settings
  • Configuration - Hardware
  • Configuration - Registry
  • Eventing - Introduction (explain what it is, the basic logic)
  • Eventing - Actions
  • Eventing - Operators

@curlymo by documentation pages, you only mean the ones on the website, not the wiki?
 
Reply
#12
As well as the wiki. And yes, i think that's what we all have i mind Wink
 
Reply
#13
@Niek, you wrote that you wrote the installation pages of the community manual. Can you merge them? Then i can continue porting various pages for the upcoming version 7.
 
Reply
#14
(05-07-2015, 09:43 PM)curlymo Wrote: @Niek, you wrote that you wrote the installation pages of the community manual. Can you merge them? Then i can continue porting various pages for the upcoming version 7.

@curlymo

I don't quite understand what installation pages you are pointing atConfused.
I did write tutorials for time math and the libcurl based sendmail action, but those are now obsolete of course. The only other thing I rember to have written so far is an example of randomization with time based rules in the wiki.
 
Reply
#15
I meant the pilight libreoffice manual on github.
 
Reply
#16
I started working on the installation manual, but haven't had time to continue working on it. (And I need to get the hang of git, it doesn't let me commit my changes to my fork...)
 
Reply
#17
I'm looking for a way to get a community driver website so eventually all frontpage pages are backened by direct community input like the wiki. I've tested various solutions to get it to work with ODT or PDF but can't find anything that fits my needs.

webODF isn't able to properly parse my pages.
pdf.js is awesome but slow and really large > 1MB

I also looked into Latex parsers but also haven't found good libraries for it.



I think i found the solution in pdf2htmlEX. That can convert pdf files magically into 99.9% almost perfect html pages.
 
Reply
#18
I downloaded the zip of pilight-manual from GitHub considering to make a translation in Italian but I encountered a problem: the page indexes (in gray) are read-only so I can't edit them.
 
Reply
#19
I would advice you to read about making indexes in libreoffice. That's easier then for me to explain how it works Smile
 
Reply
#20
Read and understood thanks.
 
Reply
  


Possibly Related Threads...
Thread Author Replies Views Last Post
  No link from manual-pages to main page? sirtet 7 2,591 01-12-2019, 01:22 PM
Last Post: lisDuh
  New manual pages curlymo 7 3,478 01-15-2018, 10:47 AM
Last Post: pilino1234
  User manual: error in wiring schema for USB nano? Fabrizio 0 1,646 11-25-2015, 04:52 PM
Last Post: Fabrizio

Forum Jump:


Browsing: 1 Guest(s)