C4DT Editors - Revision history

Domtron: added a missing
that caused the
for the next paragraph to be rendered as text on the page.

2013-11-02T15:51:17Z

added a missing </p> that caused the <p> for the next paragraph to be rendered as text on the page.

← Older revision		Revision as of 15:51, 2 November 2013
Line 1:		Line 1:
	=Introduction=		==Introduction==
	<p>As of now, you should have created an OpenClonk project and be sitting in front of something that is quite comparable to the original Clonk Editor. On the left side you have the Project Explorer (or on the right side or wherever you like, since all views can be freely arranged in Eclipse). You can use it to navigate packets as you'd do when using the editor.</p>		<p>As of now, you should have created an OpenClonk project and be sitting in front of something that is quite comparable to the original Clonk Editor. On the left side you have the Project Explorer (or on the right side or wherever you like, since all views can be freely arranged in Eclipse). You can use it to navigate packets as you'd do when using the editor.</p>
	<p>Unlike the editor though, files are generally openend not it an external program but in a tab in the Eclipse window. You can still set programs to handle specific files by either using the Open With command in the context menu of the Project Explorer or by setting a program in the preferences. The first method works on a file-by-file basis so you could tell Eclipse to open a specific graphics file with Photoshop while opening others with Paint. The second method (Preferences -> General -> Editors -> File Associations) sets a file association for all files of that type.</p>		<p>Unlike the editor though, files are generally openend not it an external program but in a tab in the Eclipse window. You can still set programs to handle specific files by either using the Open With command in the context menu of the Project Explorer or by setting a program in the preferences. The first method works on a file-by-file basis so you could tell Eclipse to open a specific graphics file with Photoshop while opening others with Paint. The second method (Preferences -> General -> Editors -> File Associations) sets a file association for all files of that type.</p>

Domtron: added a missing
that caused the
for the next paragraph to be rendered as text on the page.

2013-11-02T15:47:44Z

added a missing </p> that caused the <p> for the next paragraph to be rendered as text on the page.

← Older revision		Revision as of 15:47, 2 November 2013
Line 1:		Line 1:
	==Introduction==		=Introduction=
	<p>As of now, you should have created an OpenClonk project and be sitting in front of something that is quite comparable to the original Clonk Editor. On the left side you have the Project Explorer (or on the right side or wherever you like, since all views can be freely arranged in Eclipse). You can use it to navigate packets as you'd do when using the editor.</p>		<p>As of now, you should have created an OpenClonk project and be sitting in front of something that is quite comparable to the original Clonk Editor. On the left side you have the Project Explorer (or on the right side or wherever you like, since all views can be freely arranged in Eclipse). You can use it to navigate packets as you'd do when using the editor.</p>
	<p>Unlike the editor though, files are generally openend not it an external program but in a tab in the Eclipse window. You can still set programs to handle specific files by either using the Open With command in the context menu of the Project Explorer or by setting a program in the preferences. The first method works on a file-by-file basis so you could tell Eclipse to open a specific graphics file with Photoshop while opening others with Paint. The second method (Preferences -> General -> Editors -> File Associations) sets a file association for all files of that type.</p>		<p>Unlike the editor though, files are generally openend not it an external program but in a tab in the Eclipse window. You can still set programs to handle specific files by either using the Open With command in the context menu of the Project Explorer or by setting a program in the preferences. The first method works on a file-by-file basis so you could tell Eclipse to open a specific graphics file with Photoshop while opening others with Paint. The second method (Preferences -> General -> Editors -> File Associations) sets a file association for all files of that type.</p>
Line 39:		Line 39:
	<br clear=all>		<br clear=all>
	<p>The outline also shows types of variables and return types of functions, as inferred by the internal C4Script parser. Of course, since C4Script is relatively dynamic in its nature with eval and arbitrary attribute setting and the like, all those type inferences are without guarantee and might not reflect the true usage of the variable. A question mark following the type signals that the parser detected the possibility of the variable having just about any type so the weather forecast character is even more pronounced in that case.</p>		<p>The outline also shows types of variables and return types of functions, as inferred by the internal C4Script parser. Of course, since C4Script is relatively dynamic in its nature with eval and arbitrary attribute setting and the like, all those type inferences are without guarantee and might not reflect the true usage of the variable. A question mark following the type signals that the parser detected the possibility of the variable having just about any type so the weather forecast character is even more pronounced in that case.</p>
	<p>Type guesses in the form of [x-y: <type>] represent cases where the expression is anticipated to have some array type where the range from x to y is of the given type. There could also be some additional '…' thrown in which would signify that the array will probably have more elements at runtime than those in the specified range.		<p>Type guesses in the form of [x-y: <type>] represent cases where the expression is anticipated to have some array type where the range from x to y is of the given type. There could also be some additional '…' thrown in which would signify that the array will probably have more elements at runtime than those in the specified range.</p>

	==Errors & Warnings==		==Errors & Warnings==
	[[File:Eclipse_ProblemsView.png\|right]] <p>The script parser built into C4DT tries to detect lots of potential and actual errors, which are listed in the problems view. A script is reparsed when it gets saved. In some cases errors might become stale and won't get removed from the list automatically. What you can then do is Clean the project using Project -> Clean. This will reparse all the scripts in either the entire workspace or specific projects and hopefully remove the false errors.</p>		[[File:Eclipse_ProblemsView.png\|right]]

			<p>The script parser built into C4DT tries to detect lots of potential and actual errors, which are listed in the problems view. A script is reparsed when it gets saved. In some cases errors might become stale and won't get removed from the list automatically. What you can then do is Clean the project using Project -> Clean. This will reparse all the scripts in either the entire workspace or specific projects and hopefully remove the false errors.</p>

	<p>For a list of warnings & errors take a look at [http://bitbucket.org/mortimer/c4dt/src/tip/C4DT/src/net/arctics/clonk/parser/ParserErrorCode.java ParserErrorCode.java].</p>		<p>For a list of warnings & errors take a look at [http://bitbucket.org/mortimer/c4dt/src/tip/C4DT/src/net/arctics/clonk/parser/ParserErrorCode.java ParserErrorCode.java].</p>
	<br clear=all/>		<br clear=all/>

Mortimer: Add section about Eclipse Auto-Refresh

2012-04-10T23:46:30Z

Add section about Eclipse Auto-Refresh

← Older revision		Revision as of 23:46, 10 April 2012
Line 56:		Line 56:
	*The Preview view serves as a replacement for the preview feature found in the Clonk Editor.		*The Preview view serves as a replacement for the preview feature found in the Clonk Editor.
	*The Clonk Folder view enables quick access to packed c4group files inside the game folder of the engine set for the project whose files you are currently editing.		*The Clonk Folder view enables quick access to packed c4group files inside the game folder of the engine set for the project whose files you are currently editing.

			==Auto-Refresh==
			[[File:Eclipse_AutoRefresh.png\|right]]
			<p>When updating your local repository clone, Eclipse tends to get confused because it keeps its own cache of file contents which won't match with the actual file contents after updating, so messages like 'This and that is out of sync with the file system' will pop up. To remedy that, you can open the General->Workspace preferences and set the settings as shown on the right.

Mortimer: /* Outline */

2011-10-25T16:47:02Z

Outline

← Older revision		Revision as of 16:47, 25 October 2011
Line 38:		Line 38:
	<p>The outline allows you to filter the list of declarations using a regular expression or wildcard.</p>		<p>The outline allows you to filter the list of declarations using a regular expression or wildcard.</p>
	<br clear=all>		<br clear=all>
			<p>The outline also shows types of variables and return types of functions, as inferred by the internal C4Script parser. Of course, since C4Script is relatively dynamic in its nature with eval and arbitrary attribute setting and the like, all those type inferences are without guarantee and might not reflect the true usage of the variable. A question mark following the type signals that the parser detected the possibility of the variable having just about any type so the weather forecast character is even more pronounced in that case.</p>
			<p>Type guesses in the form of [x-y: <type>] represent cases where the expression is anticipated to have some array type where the range from x to y is of the given type. There could also be some additional '…' thrown in which would signify that the array will probably have more elements at runtime than those in the specified range.

	==Errors & Warnings==		==Errors & Warnings==

Mortimer: Move Quick Fixes up

2011-10-16T20:05:15Z

Move Quick Fixes up

← Older revision		Revision as of 20:05, 16 October 2011
Line 45:		Line 45:
	<p>Errors and Warnings listed in the Problems View can be individually deactivated if they annoy you. To do that, open up the properties window for the project you want to configure, select the Clonk category and deactivate kinds of errors/warnings to your heart's content.</p>		<p>Errors and Warnings listed in the Problems View can be individually deactivated if they annoy you. To do that, open up the properties window for the project you want to configure, select the Clonk category and deactivate kinds of errors/warnings to your heart's content.</p>
	[[File:Eclipse_ProblemsFilter.png]]		[[File:Eclipse_ProblemsFilter.png]]

			==Quick Fixes==
			[[File:Eclipse_QuickFix.png\|right]]
			<p>For certain common cases of errors, c4dt offers automatic quick fixes which are offered to you when you press Ctrl/⌘+1 while having the cursor in a script inside a region marked as erroneous/problematic.</p>

	==Additional Views==		==Additional Views==
Line 50:		Line 54:
	*The Preview view serves as a replacement for the preview feature found in the Clonk Editor.		*The Preview view serves as a replacement for the preview feature found in the Clonk Editor.
	*The Clonk Folder view enables quick access to packed c4group files inside the game folder of the engine set for the project whose files you are currently editing.		*The Clonk Folder view enables quick access to packed c4group files inside the game folder of the engine set for the project whose files you are currently editing.

	~~==Quick Fixes==~~
	~~[[File:Eclipse_QuickFix.png\|right]]~~
	<p>For certain common cases of errors, c4dt offers automatic quick fixes which are offered to you when you press Ctrl/⌘+1 while having the cursor in a script inside a region marked as erroneous/problematic.</p>

Mortimer: Add note about Quick Fixes

2011-10-16T20:04:40Z

Add note about Quick Fixes

← Older revision		Revision as of 20:04, 16 October 2011
Line 50:		Line 50:
	*The Preview view serves as a replacement for the preview feature found in the Clonk Editor.		*The Preview view serves as a replacement for the preview feature found in the Clonk Editor.
	*The Clonk Folder view enables quick access to packed c4group files inside the game folder of the engine set for the project whose files you are currently editing.		*The Clonk Folder view enables quick access to packed c4group files inside the game folder of the engine set for the project whose files you are currently editing.

			==Quick Fixes==
			[[File:Eclipse_QuickFix.png\|right]]
			<p>For certain common cases of errors, c4dt offers automatic quick fixes which are offered to you when you press Ctrl/⌘+1 while having the cursor in a script inside a region marked as erroneous/problematic.</p>

Mortimer: clear all for good measure!

2011-10-16T20:00:01Z

clear all for good measure!

← Older revision		Revision as of 20:00, 16 October 2011
Line 21:		Line 21:
	[[File:Eclipse_DeclarationsFilter.png\|right]]		[[File:Eclipse_DeclarationsFilter.png\|right]]
	<p>'''Lookup Declaration''': From any script or when having selected a file in the project explorer, you can invoke Lookup Declaration from the Clonk menu (also a candidate for a nice keyboard assignment). You can then filter all the declarations from the current selection (either the project selected in the project explorer or the script being currently edited including its #includes) using regular expressions and jump to the declaration of any identifier matched by the expression.</p>		<p>'''Lookup Declaration''': From any script or when having selected a file in the project explorer, you can invoke Lookup Declaration from the Clonk menu (also a candidate for a nice keyboard assignment). You can then filter all the declarations from the current selection (either the project selected in the project explorer or the script being currently edited including its #includes) using regular expressions and jump to the declaration of any identifier matched by the expression.</p>
			<br clear=all/>

	==Getting Content Assistance==		==Getting Content Assistance==

Mortimer: Add short description of Clonk Folder view

2011-10-16T19:59:10Z

Add short description of Clonk Folder view

← Older revision		Revision as of 19:59, 16 October 2011
Line 48:		Line 48:
	<p>C4DT adds a handful of views. Two of them will get placed in the same tabzone as the Outline view by the Clonk perspective.</p>		<p>C4DT adds a handful of views. Two of them will get placed in the same tabzone as the Outline view by the Clonk perspective.</p>
	*The Preview view serves as a replacement for the preview feature found in the Clonk Editor.		*The Preview view serves as a replacement for the preview feature found in the Clonk Editor.
			*The Clonk Folder view enables quick access to packed c4group files inside the game folder of the engine set for the project whose files you are currently editing.

Mortimer: add description about Lookup Declaration

2011-10-16T19:57:54Z

add description about Lookup Declaration

← Older revision		Revision as of 19:57, 16 October 2011
Line 12:		Line 12:
	*The Ini Files Editor also includes support for hyperlinks.		*The Ini Files Editor also includes support for hyperlinks.
	==Navigation==		==Navigation==
	Navigating to and between scripts quickly is very important. Because of that, C4DT adds several navigation features:		<p>Navigating to and between scripts quickly is very important. Because of that, C4DT adds several navigation features:
	*[[File:Eclipse_Hyperlinks.png\|right]] Hyperlinks: All valid identifiers can be turned into links by pressing Ctrl while hovering over the identifier with your mouse. When you click on them the declaration location of the thing the identifier is referring to will be opened. This works for variables, functions, definitions and also for StringTbl entries ($BlaBla$). ~~<br clear=all/>~~[[File:Eclipse_HyperlinksIni.png\|right]] Identifiers in ini editors can also be turned into hyperlinks.<br clear=all/>		*[[File:Eclipse_Hyperlinks.png\|right]] '''Hyperlinks''': All valid identifiers can be turned into links by pressing Ctrl/⌘ while hovering over the identifier with your mouse. When you click on them the declaration location of the thing the identifier is referring to will be opened. This works for variables, functions, definitions and also for StringTbl entries ($BlaBla$). [[File:Eclipse_HyperlinksIni.png\|right]] Identifiers in ini editors can also be turned into hyperlinks.</p>
	*[[File:Clonk_OpenObject.png\|right]] Open Object Dialog: The Open Object dialog can be activated using the Clonk menu in the main menu. As soon as you start typing the dialog starts listing definitions that match the typed text.<br clear=all/>		<br clear=all/>
	*[[File:Eclipse_BackForward.png\|right]] Going back and forward: When clicking on hyperlinks or navigating to other files by any other means you will always be able to go back to the original file by either pressing Alt+Left or using the yellow arrows in the toolbar.		*[[File:Clonk_OpenObject.png\|right]] '''Open Object Dialog''': The Open Object dialog can be activated using the Clonk menu in the main menu. As soon as you start typing the dialog starts listing definitions that match the typed text.
			<br clear=all/>
			<p>[[File:Eclipse_BackForward.png\|right]] '''Going back and forward''': When clicking on hyperlinks or navigating to other files by any other means you will always be able to go back to the original file by either pressing Alt+Left or using the yellow arrows in the toolbar. On a Mac, you can also install [http://marketplace.eclipse.org/content/eclipse-multi-touch Eclipse Multitouch] to navigate back and forth using gestures.</p>
			<br clear=all/>
			[[File:Eclipse_DeclarationsFilter.png\|right]]
			<p>'''Lookup Declaration''': From any script or when having selected a file in the project explorer, you can invoke Lookup Declaration from the Clonk menu (also a candidate for a nice keyboard assignment). You can then filter all the declarations from the current selection (either the project selected in the project explorer or the script being currently edited including its #includes) using regular expressions and jump to the declaration of any identifier matched by the expression.</p>

	==Getting Content Assistance==		==Getting Content Assistance==

Mortimer: /* Errors & Warnings */

2011-10-16T19:43:35Z

Errors & Warnings

← Older revision		Revision as of 19:43, 16 October 2011
Line 36:		Line 36:
	==Errors & Warnings==		==Errors & Warnings==
	[[File:Eclipse_ProblemsView.png\|right]] <p>The script parser built into C4DT tries to detect lots of potential and actual errors, which are listed in the problems view. A script is reparsed when it gets saved. In some cases errors might become stale and won't get removed from the list automatically. What you can then do is Clean the project using Project -> Clean. This will reparse all the scripts in either the entire workspace or specific projects and hopefully remove the false errors.</p>		[[File:Eclipse_ProblemsView.png\|right]] <p>The script parser built into C4DT tries to detect lots of potential and actual errors, which are listed in the problems view. A script is reparsed when it gets saved. In some cases errors might become stale and won't get removed from the list automatically. What you can then do is Clean the project using Project -> Clean. This will reparse all the scripts in either the entire workspace or specific projects and hopefully remove the false errors.</p>
	<p>For a list of warnings & errors take a look at [http://bitbucket.org/mortimer/c4dt/src/tip/C4DT/src/net/arctics/clonk/parser/ParserErrorCode.java ParserErrorCode.java].</p><br clear=all/>		<p>For a list of warnings & errors take a look at [http://bitbucket.org/mortimer/c4dt/src/tip/C4DT/src/net/arctics/clonk/parser/ParserErrorCode.java ParserErrorCode.java].</p>
			<br clear=all/>
			<p>Errors and Warnings listed in the Problems View can be individually deactivated if they annoy you. To do that, open up the properties window for the project you want to configure, select the Clonk category and deactivate kinds of errors/warnings to your heart's content.</p>
			[[File:Eclipse_ProblemsFilter.png]]

	==Additional Views==		==Additional Views==
	<p>C4DT adds a handful of views. Two of them will get placed in the same tabzone as the Outline view by the Clonk perspective.</p>		<p>C4DT adds a handful of views. Two of them will get placed in the same tabzone as the Outline view by the Clonk perspective.</p>
	*The Preview view serves as a replacement for the preview feature found in the Clonk Editor.		*The Preview view serves as a replacement for the preview feature found in the Clonk Editor.

C4DT Editors - Revision history

Domtron: added a missing that caused the for the next paragraph to be rendered as text on the page.

Domtron: added a missing that caused the for the next paragraph to be rendered as text on the page.

Mortimer: Add section about Eclipse Auto-Refresh

Mortimer: /* Outline */

Mortimer: Move Quick Fixes up

Mortimer: Add note about Quick Fixes

Mortimer: clear all for good measure!

Mortimer: Add short description of Clonk Folder view

Mortimer: add description about Lookup Declaration

Mortimer: /* Errors & Warnings */

Domtron: added a missing
that caused the
for the next paragraph to be rendered as text on the page.

Domtron: added a missing
that caused the
for the next paragraph to be rendered as text on the page.