Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More texts for "What is this" #896

Closed
musikBear opened this issue Jun 26, 2014 · 18 comments
Closed

More texts for "What is this" #896

musikBear opened this issue Jun 26, 2014 · 18 comments

Comments

@musikBear
Copy link

The fine new feature "What is this" has a lot of items that need to written. I will do my part, if wanted. We just need to get a plan for doing them, so none is done 'trice'ish'
Just let me know.
an also, -Translations .. woo - How many languages?
ooooooooooooo
Oki taking some control now
I will devide the objects that need WITs added in 3 categories

  • Instruments
  • Panels
  • Effects

Look in thread if some has 'taken' an object and are working on it. I will update the categories as WITs are made, and add 'done' WITs in order. starting here:

WITs ALREADY done:

General Instrument This is identical on all non-vst presets, and should have own datastructure or class -whatever fits architechture best..
Tab ENV/LFO

Specified Instruments (of cause only the PLUGIN tabs need to have specified wit's!)
Monstro

Panels
Automation-editor
BB-editor
FX-rack
General instrument button
LFO-controller
LFO-rack
Main-screen
Piano-roll
Song-editor

Effects

@zonkmachine
Copy link
Member

The fine new feature "What is this"

This isn't really a new feature, it's just missing text in some instances.

an also, -Translations .. woo - How many languages?

That part is up to the translators. The message string is included in a tr( "..." ), and this will tell, whatever routine is doing the job..., to include the string for translation. I think it's enough to recompile the project to make the new strings ready for translation.

We just need to get a plan for doing them, so none is done 'trice'ish'

I think the plan could be that you just start and if someone wants to join in they bump this issue.
You do a couple of them items and then do an early pull request to get feedback on the job.

@diizy
Copy link
Contributor

diizy commented Jun 26, 2014

I can add some whatsthis texts for the instruments I've written (parts
of them have them already).

@diizy
Copy link
Contributor

diizy commented Jun 26, 2014

What's this strings for Monstro are done.

Whew! That was a lot of writing...

@musikBear
Copy link
Author

All wit's for "Song-editor" controllers and logic-pane-points -done

(no commits or requests for having anything pulled, being teeth, wheelcarts, birds, or w.e. -cause i have no idea how to -yet ..looks for it in wiki :p

@diizy
Copy link
Contributor

diizy commented Jun 27, 2014

On 06/27/2014 03:09 AM, musikBear wrote:

All wit's for "Song-editor" controllers and logic-pane-points -done

Where?

@zonkmachine
Copy link
Member

@musikBear You haven't forked lmms via githubs built-in functions.
https://github.com/LMMS/lmms/wiki/Submitting-a-patch

@musikBear
Copy link
Author

Where?

ehh.. im was at home .. at my desk ..is that ..important ?
...sorrry 🍡
I know what you ask, but as i stated - i have not made a commit nor pull.
I have it here as ascii, and in cpp-strings with crlf, ready to insert

@tresf
Copy link
Member

tresf commented Jun 27, 2014

Just fork via the website and then git clone from your own fork. If you're using the GitHub GUI on Windows or Mac it's a bit easier too and then you can do your commits directly via the client which is a nice visual although the vi approach on unix is just fine as well. 😈

Be mindful of the branch you are on. I use:

git clone -b stable-1.1 http://github.com/tresf/lmms.git

... where tresf is my github account fork of the LMMS project and I specify the branch with -b stable-1.1. If you don't specify the branch it will default to whatever is "default" at that time, which is 1.0 now and will be 1.1 sometime next month likely.

Since I don't know the scope of your code changes, I don't know which branch your changes are best suited for but this should at least get you started.

@eagles051387
Copy link

I believe github have their own client applications for both windows and
mac to make cloning and what not easier to manage without haveing to log
into their website.

On Fri, Jun 27, 2014 at 11:19 PM, Tres Finocchiaro <notifications@github.com

wrote:

Just fork via the website and then git clone from your own fork. If you're
using the GUI on Windows or Mac it's a bit easier too.

Be mindful of the branch you are on. I use git clone -b stable-1.1
http://github.com/tresf/lmms.git and specify the branch with -b stable-1.1.
Since I don't know the scope of the changes, I don't know which branch your
changes are suited for.


Reply to this email directly or view it on GitHub
#896 (comment).

Jonathan Aquilina

@tresf
Copy link
Member

tresf commented Jul 22, 2014

@musikBear, here are your changes: #1015. Thanks!!

There were some issues with spacing, etc (not leaving a space after the end of a sentence) that needed to be corrected prior to committing.

If you plan to offer more contributions like this, I would highly recommend getting Ubuntu/VirtualBox set up so you can edit and preview these changes yourself prior to sending them to the project as it would reduce the burden of someone else performing sanitation.

As far as the git commits, the command line stuff is pretty quick to learn and I can help you with that.

@musikBear
Copy link
Author

If you plan to offer more contributions like this

I have 10 pages. All major components is covered.
I will find a solution for the eol issue

tobydox added a commit that referenced this issue Aug 29, 2014
diizy added a commit that referenced this issue Aug 29, 2014
diizy added a commit that referenced this issue Aug 30, 2014
@Umcaruje Umcaruje added the ux label Jun 30, 2015
@Umcaruje Umcaruje changed the title Enhancement: More texts for "What is this" More texts for "What is this" Jun 30, 2015
@musikBear
Copy link
Author

Old topic, but i have a new angle
In main-menu Under
Help | Online Help
LMMS links to the wiki.
My thoughts were that what-is-this could be constructed with this type of links.
Eg, instead of the integrated popups lmms has now, what-is-this would link to the relevant page in wiki
The benefits

  • The codebase would be without hard-coded info
  • Changes would only have to be made once (eg in wiki, not in wiki and codebase)
  • Changes would be easy to make, and not include coders

Adversaries

  • Users not online cant use it

Opinions?

@Spekular
Copy link
Member

Spekular commented Jan 14, 2017 via email

@musikBear
Copy link
Author

@Spekular but that would still mean 2 different edits if/ when something is being changed, the whole idea is to avoid having double information. If it is split in two parts, one offline, and one online, i cant see any benefits :)

@Spekular
Copy link
Member

@musikBear sure, but online-only is no good either. Besides, the information on the wiki should probably be more in depth than what fits in a tooltip. I suppose my idea would just be a convenient way to access the right wiki page.

@musikBear
Copy link
Author

@Spekular

but online-only is no good either

That is the adversary i know that, but now-a-days... oh well just a thought.. I will leave this for others to respond

@musikBear
Copy link
Author

I believe i have the solution, that would allow users to use wit's offline and still keep the wit's out of the codebase, and make editing very easy:
A HTML-document in folder 'locale' with links inside lmms.
WITs are kept out of codebase, coders not needed in maintenance, and only one file need to be kept updated, still everything work offline.
Opinions?

@husamalhomsi
Copy link
Member

Closed via #4128.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

9 participants