Hi everyone,
Interestingly Erik and I have also discussed the possibilities for
doing something similar on IRC.
Here is my proposal and some of the reasons for differing in how to
achieve the result we have in common.
- I'd propose (for a start) that we add a unique ID ($ViewID) to
every view (page) that a user can see.
(There are other reasons for wanting this from a developer
perspective so it's going to happen eventually anyway)
This ID will be generated by the developers and derived from the
view's filename.
- Add a "?' button/div to every view that has it's ID ($HelpID)
set to "Help_$ViewID"
the action on clicking the ? button would be to open a wiki page
(in a new tab/window) with the named to match the ? button's ID.
An example URL would be https://wiki.ledgersmb.com/1.5.2/$HelpID
- Create a basic wiki framework with standard "help page"
template that is used when creating a new page
- Start adding content by running a version of LedgerSMB with
the above changes and clicking on a particular "?" button to
first "create" the page, then edit it's content.
- Once we have a reasonable amount of content, and can decide
the best way of displaying it decide on one of
- display in new tab/window
- display in fixed frame or div that is made visible to the
right/bottom/left of the normal screen
- display in a floating popup div or frame that can be
dragged around the screen and resized to suit the user's
needs at the time
- Down the track as we need to support concurrent documentation
for multiple versions of LedgerSMB insert a redirection layer
between LedgerSMB and the wiki to assist with page renames and
auto importing the previous version of a help page if the
current version doesn't exist
I'm hoping to actually get the $ViewID added before next Monday
Night, and can have a suitable wiki available almost immediately.
From discussions with Erik, it should be possible (with a little
help from him) to get the "?" button added to all pages fairly
rapidly as well.
To help explain why I'd like to do it this way, rather than in
CSS or directly in our codebase/distribution files this is what I
said on IRC
I don't like the idea of it being simply done in style
sheets,
it'll make it hard to handle revision history and still ensure
doc updates are seen by all users immediately
That IMHO is where a wiki will kick ass
Regards
David G
On 18/05/16 18:31, Marjanw wrote:
Hi Bob,
Git is a version control system developed by Linus Torvalds.
It helps you to maintain a collection of files.
Git is targeted to program source files, but you can use it for any
collection of (text) files.
Read the Git Book at: https://git-scm.com/book/en/v2
Once you know Git, you'll using it for just everything!
Large binary files can be managed with git-annex.
(But first start to learn plain git.)
Regards,
Marjan
On 2016-05-18 02:47, Bob Crandell wrote:
They all need help of one kind or another. :) I guess we should decide
on what order to do them. I suggest we do Preferences and System first
then Contacts and HR. After that General Journal and Goods and
Services. That should give the new guys a foundation. From there we
just work our way down the list.
What's Git? With a little help getting started I should be fine.
Is that what you had in mind?
On Wed, 2016-05-18 at 11:51 +1200, Paul Bolger wrote:
The first thing to do would be to draw up a list of pages which need
help. How's your Git? Mine's not great...
On 18 May 2016 at 11:42, Bob Crandell <..hidden..> wrote:
Hi Paul,
I don't know what help I can be but I'm willing to try. What do you
want me to do?
Thanks
Bob
On Wed, 2016-05-18 at 10:48 +1200, Paul Bolger wrote:
Hi Bob and Erik,
My apologies for my extended absence...
If you remember around January we were discussing doing something like
this using an external stylesheet. Help could be added in
pseudoselectors (before:). Very easy to add, wouldn't mean any
application code changes, and also very easy to get rid of for users
who don't need it.
Bob: Are you interested in collaborating on getting this going?
Paul Bolger
On 18 May 2016 at 09:57, Bob Crandell <..hidden..> wrote:
That's even better yet. Some software I've seen over time had little
pop ups that was to be their help system but those pop ups only repeated
the label to the field so they were annoying and useless.
On Tue, 2016-05-17 at 09:52 +0200, Erik Huelsmann wrote:
Hi Bob,
I hope it's alright to make a suggestion or two.
Sure is! Thanks for taking the time to mail us your feedback!
For the documentation put a question mark on each screen
describing what
the screen is for with examples of what could go in each
field.
I like the idea, a lot. Thinking about it a bit more, I think we don't
have any current
documentation that we could put in the docs there. Maybe it's an idea
to link the
question mark to a wiki where everybody can help out writing this help
content,
making it a community project? What do you think?
The PDF [manual] would be more procedures like how to
reconcile the check book,
how to pay an invoice, how to conduct inventory adjustments,
how to set
the silly thing up in the first place.
Workflow documentation? Sounds good. That's something that's
cross-screen indeed.
This way the docs for the
screens can change as the program matures without having to
mess with
the manual. The manual can grow with "How do I" stuff.
Sounds sane. The problem we're currently having is that writing those
docs is possibly
more work than writing the application :-) Which is why I came up with
the wiki idea
above: making it a community project *could* help spread the workload.
Thanks for all the hard work.
Thanks for the feedback! Keep it coming!
Regards,
--
Bye,
Erik.
http://efficito.com -- Hosted accounting and ERP.
Robust and Flexible. No vendor lock-in.
------------------------------------------------------------------------------
Mobile security can be enabling, not merely restricting. Employees who
bring their own devices (BYOD) to work are irked by the imposition of MDM
restrictions. Mobile Device Manager Plus allows you to control only the
apps on BYO-devices by containerizing them, leaving personal data untouched!
https://ad.doubleclick.net/ddm/clk/304595813;131938128;j
_______________________________________________
Ledger-smb-users mailing list
..hidden..
https://lists.sourceforge.net/lists/listinfo/ledger-smb-users
--
Bob Crandell Assured Computing, Inc. DBA ComputerBase
http://www.computerbaseusa.com
541-349-0404
"The pessimist complains about the wind; the optimist expects it to
change; the realist adjusts the sails."
-- William Arthur Ward,
------------------------------------------------------------------------------
Mobile security can be enabling, not merely restricting. Employees who
bring their own devices (BYOD) to work are irked by the imposition of MDM
restrictions. Mobile Device Manager Plus allows you to control only the
apps on BYO-devices by containerizing them, leaving personal data untouched!
https://ad.doubleclick.net/ddm/clk/304595813;131938128;j
_______________________________________________
Ledger-smb-users mailing list
..hidden..
https://lists.sourceforge.net/lists/listinfo/ledger-smb-users
------------------------------------------------------------------------------
Mobile security can be enabling, not merely restricting. Employees who
bring their own devices (BYOD) to work are irked by the imposition of MDM
restrictions. Mobile Device Manager Plus allows you to control only the
apps on BYO-devices by containerizing them, leaving personal data untouched!
https://ad.doubleclick.net/ddm/clk/304595813;131938128;j
_______________________________________________
Ledger-smb-users mailing list
..hidden..
https://lists.sourceforge.net/lists/listinfo/ledger-smb-users
--
Bob Crandell Assured Computing, Inc. DBA ComputerBase
http://www.computerbaseusa.com
541-349-0404
"The pessimist complains about the wind; the optimist expects it to
change; the realist adjusts the sails."
-- William Arthur Ward,
------------------------------------------------------------------------------
Mobile security can be enabling, not merely restricting. Employees who
bring their own devices (BYOD) to work are irked by the imposition of MDM
restrictions. Mobile Device Manager Plus allows you to control only the
apps on BYO-devices by containerizing them, leaving personal data untouched!
https://ad.doubleclick.net/ddm/clk/304595813;131938128;j
_______________________________________________
Ledger-smb-users mailing list
..hidden..
https://lists.sourceforge.net/lists/listinfo/ledger-smb-users
------------------------------------------------------------------------------
Mobile security can be enabling, not merely restricting. Employees who
bring their own devices (BYOD) to work are irked by the imposition of MDM
restrictions. Mobile Device Manager Plus allows you to control only the
apps on BYO-devices by containerizing them, leaving personal data untouched!
https://ad.doubleclick.net/ddm/clk/304595813;131938128;j
_______________________________________________
Ledger-smb-users mailing list
..hidden..
https://lists.sourceforge.net/lists/listinfo/ledger-smb-users
------------------------------------------------------------------------------
Mobile security can be enabling, not merely restricting. Employees who
bring their own devices (BYOD) to work are irked by the imposition of MDM
restrictions. Mobile Device Manager Plus allows you to control only the
apps on BYO-devices by containerizing them, leaving personal data untouched!
https://ad.doubleclick.net/ddm/clk/304595813;131938128;j
_______________________________________________
Ledger-smb-users mailing list
..hidden..
https://lists.sourceforge.net/lists/listinfo/ledger-smb-users
|