This is an automated email from the ASF dual-hosted git repository. skygo pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/netbeans-website.git
The following commit(s) were added to refs/heads/master by this push: new 8c0c2ec73 wiki update with images new daebf681e Merge pull request #670 from ebarboni/checkparsing2 8c0c2ec73 is described below commit 8c0c2ec73072039ec63e087536300009501ada3c Author: Eric Barboni <sk...@apache.org> AuthorDate: Mon Jul 31 12:28:42 2023 +0200 wiki update with images --- netbeans.apache.org/src/content/wiki/70_and_older.png | Bin 0 -> 18970 bytes netbeans.apache.org/src/content/wiki/71_and_newer.png | Bin 0 -> 19008 bytes .../wiki/ChildnodesRepresentingProjectTypes.jpg | Bin 0 -> 65417 bytes netbeans.apache.org/src/content/wiki/Dependencies.jpg | Bin 0 -> 23713 bytes .../wiki/DevFaqActionAllAvailableProjectTypes.adoc | 2 +- .../src/content/wiki/DevFaqActionContextSensitive.adoc | 2 +- netbeans.apache.org/src/content/wiki/DevFaqApiSpi.adoc | 2 +- .../src/content/wiki/DevFaqCustomWindowMode.adoc | 2 +- .../src/content/wiki/DevFaqDataLoader.adoc | 2 +- .../src/content/wiki/DevFaqDotShadowFiles.adoc | 2 +- .../src/content/wiki/DevFaqEditorTopComponent.adoc | 2 +- .../src/content/wiki/DevFaqFileRecognition.adoc | 4 ++-- .../src/content/wiki/DevFaqImagesForDarkLaf.adoc | 3 +-- .../src/content/wiki/DevFaqInstalledFileLocator.adoc | 2 +- .../src/content/wiki/DevFaqLookupLazyLoad.adoc | 2 +- .../src/content/wiki/DevFaqMavenL10N.adoc | 4 +++- .../wiki/DevFaqModulesDeclarativeVsProgrammatic.adoc | 4 ++-- .../content/wiki/DevFaqMultipleTopComponentAction.adoc | 2 +- .../src/content/wiki/DevFaqNodesCustomLookup.adoc | 3 ++- .../content/wiki/DevFaqNonSingletonTopComponents.adoc | 6 +++--- ...evFaqRegisterObjectsViaInstanceOrSettingsFiles.adoc | 2 +- .../src/content/wiki/DevFaqSuitesVsClusters.adoc | 4 ++-- .../src/content/wiki/DevFaqWhatIsACluster.adoc | 4 ++-- .../wiki/DevFaqWhenToUseWhatRegistrationMethod.adoc | 4 ++-- .../wiki/EditorActionRegistrationKeymapCategory.png | Bin 0 -> 38105 bytes netbeans.apache.org/src/content/wiki/Error.gif | Bin 0 -> 730 bytes netbeans.apache.org/src/content/wiki/HtmlWizard.png | Bin 0 -> 42224 bytes netbeans.apache.org/src/content/wiki/LafWithInvert.png | Bin 0 -> 481930 bytes .../src/content/wiki/LafWithoutInvert.png | Bin 0 -> 484300 bytes .../src/content/wiki/MavenBestPractices.adoc | 4 ++-- .../src/content/wiki/Netbeans_Window_Modes.jpg | Bin 0 -> 21314 bytes netbeans.apache.org/src/content/wiki/Warning.gif | Bin 0 -> 603 bytes .../src/content/wiki/YouDontwantyourImageinverted.jpg | Bin 0 -> 384355 bytes .../branding-updater-custom_BrandingUpdaterSplash.png | Bin 0 -> 11573 bytes .../branding-updater-folder_BrandingUpdaterSplash.png | Bin 0 -> 14435 bytes netbeans.apache.org/src/content/wiki/info.png | Bin 0 -> 766 bytes .../src/content/wiki/keymapshinynewcategory.png | Bin 0 -> 40721 bytes .../project-struct-i18n_TranslateNetbeansModule.gif | Bin 0 -> 4263 bytes .../wiki/project-struct_TranslateNetbeansModule.gif | Bin 0 -> 3367 bytes 39 files changed, 32 insertions(+), 30 deletions(-) diff --git a/netbeans.apache.org/src/content/wiki/70_and_older.png b/netbeans.apache.org/src/content/wiki/70_and_older.png new file mode 100644 index 000000000..19290831c Binary files /dev/null and b/netbeans.apache.org/src/content/wiki/70_and_older.png differ diff --git a/netbeans.apache.org/src/content/wiki/71_and_newer.png b/netbeans.apache.org/src/content/wiki/71_and_newer.png new file mode 100644 index 000000000..686b78ed3 Binary files /dev/null and b/netbeans.apache.org/src/content/wiki/71_and_newer.png differ diff --git a/netbeans.apache.org/src/content/wiki/ChildnodesRepresentingProjectTypes.jpg b/netbeans.apache.org/src/content/wiki/ChildnodesRepresentingProjectTypes.jpg new file mode 100644 index 000000000..27d0b8d44 Binary files /dev/null and b/netbeans.apache.org/src/content/wiki/ChildnodesRepresentingProjectTypes.jpg differ diff --git a/netbeans.apache.org/src/content/wiki/Dependencies.jpg b/netbeans.apache.org/src/content/wiki/Dependencies.jpg new file mode 100644 index 000000000..7135a2738 Binary files /dev/null and b/netbeans.apache.org/src/content/wiki/Dependencies.jpg differ diff --git a/netbeans.apache.org/src/content/wiki/DevFaqActionAllAvailableProjectTypes.adoc b/netbeans.apache.org/src/content/wiki/DevFaqActionAllAvailableProjectTypes.adoc index a5ac895c2..11840cfae 100644 --- a/netbeans.apache.org/src/content/wiki/DevFaqActionAllAvailableProjectTypes.adoc +++ b/netbeans.apache.org/src/content/wiki/DevFaqActionAllAvailableProjectTypes.adoc @@ -38,7 +38,7 @@ The project type can be used for extending the project properties - See xref:Dev == Example of some available types in NetBeans 7.2 -image:ChildnodesRepresentingProjectTypes.jpg[]) +image:ChildnodesRepresentingProjectTypes.jpg[] [source,java] ---- diff --git a/netbeans.apache.org/src/content/wiki/DevFaqActionContextSensitive.adoc b/netbeans.apache.org/src/content/wiki/DevFaqActionContextSensitive.adoc index d645e47c4..020dd4aa9 100644 --- a/netbeans.apache.org/src/content/wiki/DevFaqActionContextSensitive.adoc +++ b/netbeans.apache.org/src/content/wiki/DevFaqActionContextSensitive.adoc @@ -35,7 +35,7 @@ There are several ways to do this, depending on what exactly you need. The basi * An action may be created and shown in a menu, toolbar or popup menu. * While it is visible on-screen, the selected file (or whatever) can change. * If it is context sensitive, it should run against the thing it was _shown for_ not whatever is selected at the millisecond when it is actually called -* People want to write main-menu and toolbar actions which are enabled and disabled based on what is xref:DevFaqTrackGlobalSelection.adoc[selected] - in practice this means writing an object that enables and disables itself based on a particular _type_ — a particular class or its subclasses — being selected (each logical window in NetBeans has its own "selection"; the "global selection" is whatever is selected in whatever window currently has focus) +* People want to write main-menu and toolbar actions which are enabled and disabled based on what is xref:DevFaqTrackGlobalSelection.adoc[selected] - in practice this means writing an object that enables and disables itself based on a particular _type_ -- a particular class or its subclasses -- being selected (each logical window in NetBeans has its own "selection"; the "global selection" is whatever is selected in whatever window currently has focus) NetBeans allows context-sensitive actions to be registered declaratively using annotations.. In the IDE, *File > New File > Module Development > Action* will generate (on the first page of the wizard, specify that you want a context sensitive action): diff --git a/netbeans.apache.org/src/content/wiki/DevFaqApiSpi.adoc b/netbeans.apache.org/src/content/wiki/DevFaqApiSpi.adoc index 9ac42eb29..c9da640ae 100644 --- a/netbeans.apache.org/src/content/wiki/DevFaqApiSpi.adoc +++ b/netbeans.apache.org/src/content/wiki/DevFaqApiSpi.adoc @@ -39,7 +39,7 @@ SPI stands for _Service Provider Interface_. It is a subset of all things that The classic example is link:http://java.sun.com/products/javamail/[JavaMail]. Its API has two sides: -* The _API side_ — which you call if you are writing a mail client or want to read a mailbox +* The _API side_ -- which you call if you are writing a mail client or want to read a mailbox * The _SPI side_ if you are providing a wire-protocol handler to allow JavaMail to talk to a new kind of server, such as a news or IMAP server Users of the API rarely need to see or talk to the SPI classes, and vice-versa. diff --git a/netbeans.apache.org/src/content/wiki/DevFaqCustomWindowMode.adoc b/netbeans.apache.org/src/content/wiki/DevFaqCustomWindowMode.adoc index b606bbb86..261b1c024 100644 --- a/netbeans.apache.org/src/content/wiki/DevFaqCustomWindowMode.adoc +++ b/netbeans.apache.org/src/content/wiki/DevFaqCustomWindowMode.adoc @@ -35,7 +35,7 @@ image:Netbeans_Window_Modes.jpg[] Here's the link:http://www.yworks.com/en/products_yed_about.html[yEd] file for the above image in case this is incorrect or needs to be modified: -image:Netbeans_Window_Modes.graphml[] +// not available on webarchive image:Netbeans_Window_Modes.graphml[] If you want a custom "mode" or location for a top component follow this blog from Geertjan's Blog: xref:../blogs/geertjan/creating_a_new_mode_in.adoc[Creating A New Mode In Your Application] //// diff --git a/netbeans.apache.org/src/content/wiki/DevFaqDataLoader.adoc b/netbeans.apache.org/src/content/wiki/DevFaqDataLoader.adoc index 285cc7fb3..9712e0674 100644 --- a/netbeans.apache.org/src/content/wiki/DevFaqDataLoader.adoc +++ b/netbeans.apache.org/src/content/wiki/DevFaqDataLoader.adoc @@ -64,7 +64,7 @@ DataLoaders are factories for xref:DevFaqDataObject.adoc[DataObjects]. Typicall Modules that provide the ability the system to open (or otherwise use) files of a particular type will register DataLoaders for those types. So typically for each file type (as defined by MIME type, which in practice usually means file name extension, or XML subtype) there is a matching DataObject subclass. -Note that DataLoaders do not _have_ to be tied to MIME types — you can still write a DataLoader subclass, registered the old-fashioned way via the JAR manifest, which gets the first chance in the system to claim *any* file in the system. However this is rarely wise or useful to do. +Note that DataLoaders do not _have_ to be tied to MIME types -- you can still write a DataLoader subclass, registered the old-fashioned way via the JAR manifest, which gets the first chance in the system to claim *any* file in the system. However this is rarely wise or useful to do. //// == Apache Migration Information diff --git a/netbeans.apache.org/src/content/wiki/DevFaqDotShadowFiles.adoc b/netbeans.apache.org/src/content/wiki/DevFaqDotShadowFiles.adoc index 08f0ab94c..a39874439 100644 --- a/netbeans.apache.org/src/content/wiki/DevFaqDotShadowFiles.adoc +++ b/netbeans.apache.org/src/content/wiki/DevFaqDotShadowFiles.adoc @@ -72,7 +72,7 @@ uses shadow files to link to real directories on disk. == Creating Shadow Files Programmatically -If you need to create `.shadow` files programmatically, use link:https://bits.netbeans.org/dev/javadoc/org-openide-loaders/org/openide/loaders/DataShadow.html#create(org.openide.loaders.DataFolder,%20java.lang.String,%20org.openide.loaders.DataObject[`DataShadow.create()`] — do not write `FileObject`s and try to set attributes on them. In an XML layer, a `DataShadow`'s original file is pointed to by a file attribute. On disk, that is accomplished via the _file's content_ instead. [...] +If you need to create `.shadow` files programmatically, use link:https://bits.netbeans.org/dev/javadoc/org-openide-loaders/org/openide/loaders/DataShadow.html#create(org.openide.loaders.DataFolder,%20java.lang.String,%20org.openide.loaders.DataObject[`DataShadow.create()`] -- do not write `FileObject`s and try to set attributes on them. In an XML layer, a `DataShadow`'s original file is pointed to by a file attribute. On disk, that is accomplished via the _file's content_ instead. To [...] //// == Apache Migration Information diff --git a/netbeans.apache.org/src/content/wiki/DevFaqEditorTopComponent.adoc b/netbeans.apache.org/src/content/wiki/DevFaqEditorTopComponent.adoc index 2e46ecffa..6a3489d07 100644 --- a/netbeans.apache.org/src/content/wiki/DevFaqEditorTopComponent.adoc +++ b/netbeans.apache.org/src/content/wiki/DevFaqEditorTopComponent.adoc @@ -183,7 +183,7 @@ The skeleton of our DataObject class is generated from the *New > File Type* tem * Modify it so that we can pass the text the user typed to it, and it will mark itself modified and become savable (causing *File > Save* and *File > Save All* to become enabled) * We will implement the setContent(String) method to * Make a `link:https://bits.netbeans.org/dev/javadoc/org-openide-nodes/org/openide/cookies/SaveCookie.html[SaveCookie]` available, which is what the various built-in Save actions operate on -* Call `DataObject.setModified()`—this guarantees that the user will be given a chance to save the file if they shut down the application before saving. +* Call `DataObject.setModified()` -- this guarantees that the user will be given a chance to save the file if they shut down the application before saving. [source,java] ---- diff --git a/netbeans.apache.org/src/content/wiki/DevFaqFileRecognition.adoc b/netbeans.apache.org/src/content/wiki/DevFaqFileRecognition.adoc index 5e89cb76d..c3335defd 100644 --- a/netbeans.apache.org/src/content/wiki/DevFaqFileRecognition.adoc +++ b/netbeans.apache.org/src/content/wiki/DevFaqFileRecognition.adoc @@ -47,9 +47,9 @@ The way NetBeans detects files is this: * A module which wants to implement support for a file type registers a `link:https://bits.netbeans.org/dev/javadoc/org-openide-filesystems/org/openide/filesystems/MIMEResolver.html[MIMEResolver]` that is given a chance to claim a file the first time the system sees it (typically you do not write your own MIMEResolver, you just declaratively register a MIME type against a file extension or XML DTD). -* That module (or some other one) also provides a `xref:DevFaqDataLoader.adoc[DataLoader]` — a factory for custom xref:DevFaqDataObject.adoc[DataObject]s that are specific to this file type. The DataObject in turn provides the Node (icon, etc.) that you see in the user interface. +* That module (or some other one) also provides a `xref:DevFaqDataLoader.adoc[DataLoader]` -- a factory for custom xref:DevFaqDataObject.adoc[DataObject]s that are specific to this file type. The DataObject in turn provides the Node (icon, etc.) that you see in the user interface. -So, to recap — when you expand a folder, and the system goes about showing a tree of nodes representing files, what happens is: +So, to recap -- when you expand a folder, and the system goes about showing a tree of nodes representing files, what happens is: 1. The child FileObjects of the folder are listed 2. Each child FileObject is checked by extension (and DTD in the case of XML files) against registered MIME types / MIMEResolvers. diff --git a/netbeans.apache.org/src/content/wiki/DevFaqImagesForDarkLaf.adoc b/netbeans.apache.org/src/content/wiki/DevFaqImagesForDarkLaf.adoc index 24c38cb55..2b8fae676 100644 --- a/netbeans.apache.org/src/content/wiki/DevFaqImagesForDarkLaf.adoc +++ b/netbeans.apache.org/src/content/wiki/DevFaqImagesForDarkLaf.adoc @@ -111,7 +111,6 @@ As of Netbeans 8.2, the Branding dialog within the Netbeans IDE is not designed If you have displaying issues with your controls, try to set the `HONOR_DISPLAY_PROPERTIES`-clientproperty. -` [source,java] ---- @@ -121,7 +120,7 @@ pane.putClientProperty(JEditorPane.HONOR_DISPLAY_PROPERTIES, Boolean.TRUE); pane.putClientProperty(JTextPane.HONOR_DISPLAY_PROPERTIES, Boolean.TRUE); ---- -` + //// == Apache Migration Information diff --git a/netbeans.apache.org/src/content/wiki/DevFaqInstalledFileLocator.adoc b/netbeans.apache.org/src/content/wiki/DevFaqInstalledFileLocator.adoc index de2e92e80..1a4d44a10 100644 --- a/netbeans.apache.org/src/content/wiki/DevFaqInstalledFileLocator.adoc +++ b/netbeans.apache.org/src/content/wiki/DevFaqInstalledFileLocator.adoc @@ -37,7 +37,7 @@ Sometimes you need to bundle some additional files with your module (for example NetBeans provides a simple and straightforward way to bundle whatever files you want into a module project: -* Create a folder in your project root directory called `release/` (note this means the _project root_—the directory containing `src/` and `nbproject/` and `MANIFEST.MF`, _not_ the source root directory of your module project!) +* Create a folder in your project root directory called `release/` (note this means the _project root_ -- the directory containing `src/` and `nbproject/` and `MANIFEST.MF`, _not_ the source root directory of your module project!) * Put anything you want bundled with your module in that directory or a subdirectory of `release/` * The entire subtree of this folder will be included in your xref:DevFaqWhatIsACluster.adoc[cluster] and bundled into your module's xref:DevFaqWhatIsNbm.adoc[NBM file] * Note that if what you are adding is a native library (DLL, .so file, etc.) there is xref:DevFaqNativeLibraries.adoc[a specific place to put this] diff --git a/netbeans.apache.org/src/content/wiki/DevFaqLookupLazyLoad.adoc b/netbeans.apache.org/src/content/wiki/DevFaqLookupLazyLoad.adoc index 395d7aae4..153f47abc 100644 --- a/netbeans.apache.org/src/content/wiki/DevFaqLookupLazyLoad.adoc +++ b/netbeans.apache.org/src/content/wiki/DevFaqLookupLazyLoad.adoc @@ -110,7 +110,7 @@ public class LazyLoadingDelegate implements InstanceContent.Convertor<Token, AnE ---- -Your link:https://bits.netbeans.org/dev/javadoc/org-openide-awt/org/openide/awt/Actions.html#context[context-sensitive action] will behave normally—it does not need to know about the lazy loading (code not relevant to lazy loading has been removed for the sake of brevity): +Your link:https://bits.netbeans.org/dev/javadoc/org-openide-awt/org/openide/awt/Actions.html#context[context-sensitive action] will behave normally -- it does not need to know about the lazy loading (code not relevant to lazy loading has been removed for the sake of brevity): [source,java] ---- diff --git a/netbeans.apache.org/src/content/wiki/DevFaqMavenL10N.adoc b/netbeans.apache.org/src/content/wiki/DevFaqMavenL10N.adoc index f47bb1641..400546b11 100644 --- a/netbeans.apache.org/src/content/wiki/DevFaqMavenL10N.adoc +++ b/netbeans.apache.org/src/content/wiki/DevFaqMavenL10N.adoc @@ -34,7 +34,9 @@ If you have localized versions of resources _in your own modules_, you can simpl But to localize _other people's modules_, then as explained in link:https://bits.netbeans.org/dev/javadoc/org-openide-modules/org/openide/modules/doc-files/i18n-branding.html#placement[Physical Placement of Localized Resources] you will need to create `modules/locale/*_*.jar` JARs with the localized resources. (Simply bundling localized resources in your own module will not work, because these are usually searched for starting with the original module's `ClassLoader`, which cannot "see" [...] -The simplest way to do this is to use the existing [link:http://mojo.codehaus.org/nbm-maven-plugin/branding-mojo.html[http://mojo.codehaus.org/nbm-maven-plugin/branding-mojo.html] `nbm:branding` goal], which despite its name can handle localization as well as branding. (These are nearly interchangeable in the NB Platform.) image:Localedemo.zip[] demonstrates how to localize parts of the Options dialog to Czech. Take note of: +The simplest way to do this is to use the existing [link:http://mojo.codehaus.org/nbm-maven-plugin/branding-mojo.html[http://mojo.codehaus.org/nbm-maven-plugin/branding-mojo.html] `nbm:branding` goal], which despite its name can handle localization as well as branding. (These are nearly interchangeable in the NB Platform.) +//image:Localedemo.zip[] not available on webarchive +demonstrates how to localize parts of the Options dialog to Czech. Take note of: * `lokalizace/pom.xml` asks to use this goal when building the module. It overrides the "branding token" (otherwise inherited from the parent POM) with your locale identifier. (Specifying this custom execution is required in the 3.3 plugin; future versions may run the goal automatically during the package phase when there is anything to process, but you would still need to declare the locale in your plugin configuration.) * `lokalizace/src/main/nbm-branding/` contains the actual localizations. diff --git a/netbeans.apache.org/src/content/wiki/DevFaqModulesDeclarativeVsProgrammatic.adoc b/netbeans.apache.org/src/content/wiki/DevFaqModulesDeclarativeVsProgrammatic.adoc index b3d080afe..6c1655fd1 100644 --- a/netbeans.apache.org/src/content/wiki/DevFaqModulesDeclarativeVsProgrammatic.adoc +++ b/netbeans.apache.org/src/content/wiki/DevFaqModulesDeclarativeVsProgrammatic.adoc @@ -32,10 +32,10 @@ Long ago, in a galaxy far far away, most objects in NetBeans were created during startup. That works fine for a small application. It is disaster for a large application - with each new component in the system, startup time gets longer, garbage collections get more frequent and memory requirements rise. Because of this, today, most of the APIs you will use to install things into the the IDE or a xref:../kb/docs/platform/index.adoc[NetBeans Platform-based application] involve a text entry of some sort, -such as xref:DevFaqModulesLayerFile.adoc[putting something in an XML file]), or a plain-text file naming some classes in your JAR file's `META-INF/services` directory — _not_ running Java code. +such as xref:DevFaqModulesLayerFile.adoc[putting something in an XML file], or a plain-text file naming some classes in your JAR file's `META-INF/services` directory -- _not_ running Java code. *A well-behaved module should do nothing on startup.* -The main ways to accomplish this goal are to use either the [link:https://bits.netbeans.org/dev/javadoc/org-openide-util-lookup/org/openide/util/lookup/ServiceProvider.html[http://bits.netbeans.org/dev/javadoc/org-openide-util-lookup/org/openide/util/lookup/ServiceProvider.html] `@ServiceProvider`] annotation (which generates the aforementioned `META-INF/services` files at compile-time), or by registering files or objects in your module's xref:DevFaqModulesLayerFile.adoc[XML layer file]. [...] +The main ways to accomplish this goal are to use either the link:https://bits.netbeans.org/dev/javadoc/org-openide-util-lookup/org/openide/util/lookup/ServiceProvider.html[`@ServiceProvider`] annotation (which generates the aforementioned `META-INF/services` files at compile-time), or by registering files or objects in your module's xref:DevFaqModulesLayerFile.adoc[XML layer file]. As of NetBeans 6.9, there are link:http://wiki.apidesign.org/wiki/CompileTimeCache[a number of annotations [...] Using declarative mechanisms, your objects will be instantiated when they are needed to do actual work. Until something really needs to call them, they don't need to be created and their classes are not loaded. diff --git a/netbeans.apache.org/src/content/wiki/DevFaqMultipleTopComponentAction.adoc b/netbeans.apache.org/src/content/wiki/DevFaqMultipleTopComponentAction.adoc index 23f47ebd1..ac8b1d01f 100644 --- a/netbeans.apache.org/src/content/wiki/DevFaqMultipleTopComponentAction.adoc +++ b/netbeans.apache.org/src/content/wiki/DevFaqMultipleTopComponentAction.adoc @@ -130,7 +130,7 @@ public class MultiTopComponent extends TopComponent { } ---- -This class contains _persistence_ code - particularly the `link:https://bits.netbeans.org/dev/javadoc/org-netbeans-modules-settings/org/netbeans/api/settings/ConvertAsProperties.html[@ConvertAsProperties]` annotation and the methods `readProperties()``writeProperties()` and `getPersistenceType()`. These methods save some information about our TopComponent to disk on shutdown, in the form of a `link:http://java.sun.com/javase/6/docs/api/java/util/Properties.html[Properties]` object. If [...] +This class contains _persistence_ code - particularly the `link:https://bits.netbeans.org/dev/javadoc/org-netbeans-modules-settings/org/netbeans/api/settings/ConvertAsProperties.html[@ConvertAsProperties]` annotation and the methods `readProperties()``writeProperties()` and `getPersistenceType()`. These methods save some information about our TopComponent to disk on shutdown, in the form of a `link:http://java.sun.com/javase/6/docs/api/java/util/Properties.html[Properties]` object. If [...] == Writing an Action which provides an array of menu items diff --git a/netbeans.apache.org/src/content/wiki/DevFaqNodesCustomLookup.adoc b/netbeans.apache.org/src/content/wiki/DevFaqNodesCustomLookup.adoc index 88132d729..296b66da5 100644 --- a/netbeans.apache.org/src/content/wiki/DevFaqNodesCustomLookup.adoc +++ b/netbeans.apache.org/src/content/wiki/DevFaqNodesCustomLookup.adoc @@ -116,7 +116,8 @@ You can then add and remove objects from your `InstanceContent` and the `DataObj *Caveat 1: You really must override `createNodeDelegate()`* or otherwise (in your `DataNode` subclass) pass your `DataObject`'s `Lookup` to your `DataNode`'s constructor. Otherwise its lookup will be `getCookieSet().getLookup()` and nothing added to your `InstanceContent` will appear in the `Lookup` of your `Node`. So, _if you use AbstractLookup in a DataObject, make sure its Node is really using your DataObject's Lookup_. -*Caveat 2: A DataObject should always appear in its own Lookup* — If you are _really sure_ that nothing is going to use your `DataObject`'s `CookieSet` at all, you can omit merging `getCookieSet().getLookup()` into the `ProxyLookup` in the constructor. However, many things will not work correctly if _the DataObject itself_ cannot be found in its own `Lookup`. If you are going to do that, replace `getCookieSet().getLookup()` with `Lookups.singleton(this)` to ensure it is present a [...] +*Caveat 2: A DataObject should always appear in its own Lookup* -- If you are _really sure_ that nothing is going to use your `DataObject's `CookieSet` at all, you can omit merging `getCookieSet().getLookup()` into the `ProxyLookup` in the constructor. However, many things will not work correctly if _the DataObject itself_ cannot be found in its own `Lookup`. If you are going to do that, replace `getCookieSet().getLookup()` with `Lookups.singleton(this)` to ensure it is present and can [...] + //// == Apache Migration Information diff --git a/netbeans.apache.org/src/content/wiki/DevFaqNonSingletonTopComponents.adoc b/netbeans.apache.org/src/content/wiki/DevFaqNonSingletonTopComponents.adoc index 988c6b684..841a2a2ee 100644 --- a/netbeans.apache.org/src/content/wiki/DevFaqNonSingletonTopComponents.adoc +++ b/netbeans.apache.org/src/content/wiki/DevFaqNonSingletonTopComponents.adoc @@ -41,7 +41,7 @@ Instead, use _New > JPanel Form_. Once the new JPanel is created, switch to the * Override `getPersistenceType()`. * If you _do not_ want your components reopened on restart -* return `PERSISTENCE_NEVER`—that is all you need to do to make sure they are not preserved across restarts. +* return `PERSISTENCE_NEVER` -- that is all you need to do to make sure they are not preserved across restarts. * If you _do_ want your components reopened on restart, then * return `PERSISTENCE_ONLY_OPENED` from `getPersistenceType()` * Add the following slightly-cryptic annotation to the class: `@ConvertAsProperties(dtd = "-//com.yourmodule.yourpackage//YourTopComponent//EN", autostore = false)`, replacing the package and class name with your own. This identifies a DTD. You do not need to define the DTD. You just need to give it a unique namespace that nothing else is using. Package and class name work well for that. @@ -65,9 +65,9 @@ In your TopComponent's .java source file: * If you have methods called `writeReplace()`and an inner class called `ResolvableHelper` (NetBeans 6.8 and earlier): * Delete the `writeReplace()` method (typically towards the end of the file) * Delete the `ResolvableHelper` inner class (typically towards the end of the file) -* If you _do not want persistence across restarts_ — you are returning PERSISTENCE_NEVER from `getPersistenceType()` +* If you _do not want persistence across restarts_ -- you are returning PERSISTENCE_NEVER from `getPersistenceType()` * If you have a `@ConvertAsProperties` annotation and `readProperties(Properties)` and `writeProperties(Properties)` methods, delete the annotation and both methods -* If _do want persistence across restarts_ — you are returning `PERSISTENCE_ONLY_OPENED` from`getPersistenceType()` +* If _do want persistence across restarts_ -- you are returning `PERSISTENCE_ONLY_OPENED` from`getPersistenceType()` * If you already have the `@ConvertAsProperties` annotation and `readProperties(Properties)` and `writeProperties(Properties)` methods just leave them there * If you do not have the annotation and those methods, implement them as described in the previous section diff --git a/netbeans.apache.org/src/content/wiki/DevFaqRegisterObjectsViaInstanceOrSettingsFiles.adoc b/netbeans.apache.org/src/content/wiki/DevFaqRegisterObjectsViaInstanceOrSettingsFiles.adoc index fd9c4c5d2..f404f509a 100644 --- a/netbeans.apache.org/src/content/wiki/DevFaqRegisterObjectsViaInstanceOrSettingsFiles.adoc +++ b/netbeans.apache.org/src/content/wiki/DevFaqRegisterObjectsViaInstanceOrSettingsFiles.adoc @@ -48,7 +48,7 @@ There are a number of kinds of files which are treated (and can be transformed i |`.settings` files |In specialized situations when the object may be saved back to disk with changed state at runtime and you cannot simply use `NbPreferences` |Create an XML file in your module for your settings file, populated as described in xref:DevFaqDotSettingsFiles.adoc[the .settings file FAQ]. Register that file in some folder by specifying the XML file as the URL of the `<file>` entry in your layer, e.g. `<file name="MyObject.settings" url="theActualFile.xml" [...] |`.shadow` files |If you want your object to be a pseudo-singleton, but it will be registered in multiple folders, or the user may delete the shadow file and you need to provide a way for the user to recover it (i.e. a way to create a new `.shadow` file) |`xref:DevFaqDotShadowFiles.adoc[.shadow]` files are like unix symbolic links - they point to another file somewhere else in the xref:DevFaqSystemFilesystem.adoc[system filesystem] or on disk, and behave as if they were really that file. [...] - An example of this is Menu and Toolbar actions — all actions are registered in subfolders of the `Actions/` folder in the system filesystem. The user might manually delete or rearrange them; the UI that allows this can also show all available actions, so that the user can replace accidentally deleted actions. + An example of this is Menu and Toolbar actions -- all actions are registered in subfolders of the `Actions/` folder in the system filesystem. The user might manually delete or rearrange them; the UI that allows this can also show all available actions, so that the user can replace accidentally deleted actions. |`.ser` (serialized object) files |Basically never |Write a serialized object out to disk in a file with the extension `.ser`, either on the fly at runtime into some folder under `link:https://bits.netbeans.org/dev/javadoc/org-openide-filesystems/org/openide/filesystems/FileUtil.html#getConfigFile(java.lang.String)[FileUtil.getConfigFile()]`, or serialize an object ahead of time somehow, copy it into your module sources, and register something like `<file name="foo.ser" url="relative/pat [...] diff --git a/netbeans.apache.org/src/content/wiki/DevFaqSuitesVsClusters.adoc b/netbeans.apache.org/src/content/wiki/DevFaqSuitesVsClusters.adoc index 4ae794db4..0f91d288b 100644 --- a/netbeans.apache.org/src/content/wiki/DevFaqSuitesVsClusters.adoc +++ b/netbeans.apache.org/src/content/wiki/DevFaqSuitesVsClusters.adoc @@ -65,11 +65,11 @@ The installation is divided into clusters for purposes of: 1. Conceptual clarity. 2. Mapping to native packaging systems such as RPM, Debian/Ubuntu packages, Solaris packages, etc. -The NetBeans team has a policy of treating inter-cluster module dependencies as more significant than intra-cluster module dependencies with respect to backward compatibility. The goal is to make it possible for product teams building on top of the NetBeans IDE to select a subset of the IDE to use—with cluster granularity rather than with module granularity. +The NetBeans team has a policy of treating inter-cluster module dependencies as more significant than intra-cluster module dependencies with respect to backward compatibility. The goal is to make it possible for product teams building on top of the NetBeans IDE to select a subset of the IDE to use -- with cluster granularity rather than with module granularity. Cluster-granularity is simpler to grasp and integrate with native packaging (if the NetBeans IDE consisted of 500 Debian packages, nobody would be particularly happy about that). But there is nothing preventing you from reusing a subset with module granularity. -The NetBeans launcher (`nbexec`) accepts a list of cluster directories to load modules from—basically a search path. There are no further semantics to clusters. +The NetBeans launcher (`nbexec`) accepts a list of cluster directories to load modules from -- basically a search path. There are no further semantics to clusters. The suite project type has a standard build target to assemble a complete application. For simplicity, it simply places all modules built from suite sources into their own cluster named in accordance with the suite's name. diff --git a/netbeans.apache.org/src/content/wiki/DevFaqWhatIsACluster.adoc b/netbeans.apache.org/src/content/wiki/DevFaqWhatIsACluster.adoc index 422941ae3..e67997feb 100644 --- a/netbeans.apache.org/src/content/wiki/DevFaqWhatIsACluster.adoc +++ b/netbeans.apache.org/src/content/wiki/DevFaqWhatIsACluster.adoc @@ -60,12 +60,12 @@ The _result of_ compiling a module suite is typically a cluster. A cluster is so Here's the history of clusters: -* Originally, NetBeans didn't have "clusters"—there was just $NB_HOME/modules/, a bunch of JAR files, and some XML files saying what was enabled and what was not. You looked up the installation directory using `System.getProperty("netbeans.home")` +* Originally, NetBeans didn't have "clusters" -- there was just $NB_HOME/modules/, a bunch of JAR files, and some XML files saying what was enabled and what was not. You looked up the installation directory using `System.getProperty("netbeans.home")` * Modules are libraries - like any other library or DLL or `.so` used by applications - and it is normal for multiple applications to use the same copy of some library * Sun had a number of NetBeans-based applications. So might anyone creating a link:http://platform.netbeans.org[NetBeans Platform-based application]. The platform is the same for all of them; so are some other parts depending on what modules those applications use. * Some operating systems will _not allow_ you to distribute native OS packages that will clutter up a user's disk with extra copies of files the user already has. The guidelines for Solaris, Debian, Ubuntu and other operating systems, all request or require that, if a library already exists on the target machine, you should use that library in-place, not install your own copy of it. If we wanted Ubuntu and Debian users to be able to type `apt get netbeans`, we needed to solve this prob [...] * The platform, and other parts of NetBeans therefore should be able to be shared among multiple applications and used by them at the same time. -* Therefore, a NetBeans-based application should not assume that all of its parts ("clusters" of modules which interdepend) are underneath the same directory on disk—the platform might be in one directory, while the Java modules are someplace else entirely. +* Therefore, a NetBeans-based application should not assume that all of its parts ("clusters" of modules which interdepend) are underneath the same directory on disk -- the platform might be in one directory, while the Java modules are someplace else entirely. * Before this, a typical way to find a file underneath a NetBeans install was new File(System.getProperty("netbeans.home")) to get the NB install directory; then you could try to find a file somewhere under that directory. * If there is not necessarily an "install directory" at all, then you need something like link:https://bits.netbeans.org/dev/javadoc/org-openide-modules/org/openide/modules/InstalledFileLocator.html[InstalledFileLocator], which knows about the cluster directories being used in the running application, and can look in all of them. That is much cleaner than you having to write the code to figure out where all of those directories are and look in each one. diff --git a/netbeans.apache.org/src/content/wiki/DevFaqWhenToUseWhatRegistrationMethod.adoc b/netbeans.apache.org/src/content/wiki/DevFaqWhenToUseWhatRegistrationMethod.adoc index 159731a1d..5bc1bcf2d 100644 --- a/netbeans.apache.org/src/content/wiki/DevFaqWhenToUseWhatRegistrationMethod.adoc +++ b/netbeans.apache.org/src/content/wiki/DevFaqWhenToUseWhatRegistrationMethod.adoc @@ -80,9 +80,9 @@ If there will potentially be a large number of subclasses of your interface, try === Why Declarative Icon and Display Name Registration Is Particularly Important -Many pieces of user interface in NetBeans — almost any tree view — is a view of a folder on disk, or a folder in the system filesystem. The Services tab is such a view; the Projects tab composes several such views; the left and right sides of the first pages of the New File and New Project wizards are such views. +Many pieces of user interface in NetBeans -- almost any tree view -- is a view of a folder on disk, or a folder in the system filesystem. The Services tab is such a view; the Projects tab composes several such views; the left and right sides of the first pages of the New File and New Project wizards are such views. -The need to simply show an icon and a name should not ever be the trigger for loading hundreds or even thousands of classes (bear in mind that loading your class may mean loading many other classes — and the link:http://www.securingjava.com/chapter-two/chapter-two-6.html[Java Bytecode Verifier] may trigger loading many more classes than you expect). +The need to simply show an icon and a name should not ever be the trigger for loading hundreds or even thousands of classes (bear in mind that loading your class may mean loading many other classes -- and the link:http://www.securingjava.com/chapter-two/chapter-two-6.html[Java Bytecode Verifier] may trigger loading many more classes than you expect). You can handle this very simply with `.instance` files: diff --git a/netbeans.apache.org/src/content/wiki/EditorActionRegistrationKeymapCategory.png b/netbeans.apache.org/src/content/wiki/EditorActionRegistrationKeymapCategory.png new file mode 100644 index 000000000..eeb8d6eac Binary files /dev/null and b/netbeans.apache.org/src/content/wiki/EditorActionRegistrationKeymapCategory.png differ diff --git a/netbeans.apache.org/src/content/wiki/Error.gif b/netbeans.apache.org/src/content/wiki/Error.gif new file mode 100644 index 000000000..7d0ea445a Binary files /dev/null and b/netbeans.apache.org/src/content/wiki/Error.gif differ diff --git a/netbeans.apache.org/src/content/wiki/HtmlWizard.png b/netbeans.apache.org/src/content/wiki/HtmlWizard.png new file mode 100644 index 000000000..f91c6032e Binary files /dev/null and b/netbeans.apache.org/src/content/wiki/HtmlWizard.png differ diff --git a/netbeans.apache.org/src/content/wiki/LafWithInvert.png b/netbeans.apache.org/src/content/wiki/LafWithInvert.png new file mode 100644 index 000000000..26f398047 Binary files /dev/null and b/netbeans.apache.org/src/content/wiki/LafWithInvert.png differ diff --git a/netbeans.apache.org/src/content/wiki/LafWithoutInvert.png b/netbeans.apache.org/src/content/wiki/LafWithoutInvert.png new file mode 100644 index 000000000..4de45ba1a Binary files /dev/null and b/netbeans.apache.org/src/content/wiki/LafWithoutInvert.png differ diff --git a/netbeans.apache.org/src/content/wiki/MavenBestPractices.adoc b/netbeans.apache.org/src/content/wiki/MavenBestPractices.adoc index 40a5900e8..f0ce9cbb7 100644 --- a/netbeans.apache.org/src/content/wiki/MavenBestPractices.adoc +++ b/netbeans.apache.org/src/content/wiki/MavenBestPractices.adoc @@ -51,7 +51,7 @@ the subject. The NetBeans IDE can automatically recognize any existing Apache Maven project. If you have such a project, just use the Open Project dialog (to be invoked via Ctrl-Shift-O keyboard shortcut, icon in the toolbar or the File/Open project menu item). All the recognized Maven projects should be marked by the Maven project type icon. If you select such folder in the file chooser, you get the project's name and a list of subprojects on the right hand side. -image::open_MavenBestPractices.png[] +image::Open_MavenBestPractices.png[] As you can see in the picture above, the project name for Maven-based projects is composed of 2 elements: the POM <name> element (if not present, then @@ -524,7 +524,7 @@ At the top of the browser there are 3 icons. * The left most is "Refresh" which will reindex the local repository (local repository has a brown/orange repository icon in the browser) and will check the remote locations for index updates. If there are updates or the index was not present locally yet, new index is retrieved. * The middle icon represents the "Add Repository" action. When you click it, a dialog shown which allows you to enter new repository locations. -image::Repository-custom_MavenBestPractices.png]][] +image::Repository-custom_MavenBestPractices.png[] TIP: If you have your own company repository manager (you should have one ideally, there are multiple one to choose from: diff --git a/netbeans.apache.org/src/content/wiki/Netbeans_Window_Modes.jpg b/netbeans.apache.org/src/content/wiki/Netbeans_Window_Modes.jpg new file mode 100644 index 000000000..2e1bf9271 Binary files /dev/null and b/netbeans.apache.org/src/content/wiki/Netbeans_Window_Modes.jpg differ diff --git a/netbeans.apache.org/src/content/wiki/Warning.gif b/netbeans.apache.org/src/content/wiki/Warning.gif new file mode 100644 index 000000000..019c342fb Binary files /dev/null and b/netbeans.apache.org/src/content/wiki/Warning.gif differ diff --git a/netbeans.apache.org/src/content/wiki/YouDontwantyourImageinverted.jpg b/netbeans.apache.org/src/content/wiki/YouDontwantyourImageinverted.jpg new file mode 100644 index 000000000..0d816b971 Binary files /dev/null and b/netbeans.apache.org/src/content/wiki/YouDontwantyourImageinverted.jpg differ diff --git a/netbeans.apache.org/src/content/wiki/branding-updater-custom_BrandingUpdaterSplash.png b/netbeans.apache.org/src/content/wiki/branding-updater-custom_BrandingUpdaterSplash.png new file mode 100644 index 000000000..dca7b1424 Binary files /dev/null and b/netbeans.apache.org/src/content/wiki/branding-updater-custom_BrandingUpdaterSplash.png differ diff --git a/netbeans.apache.org/src/content/wiki/branding-updater-folder_BrandingUpdaterSplash.png b/netbeans.apache.org/src/content/wiki/branding-updater-folder_BrandingUpdaterSplash.png new file mode 100644 index 000000000..10a8503d8 Binary files /dev/null and b/netbeans.apache.org/src/content/wiki/branding-updater-folder_BrandingUpdaterSplash.png differ diff --git a/netbeans.apache.org/src/content/wiki/info.png b/netbeans.apache.org/src/content/wiki/info.png new file mode 100644 index 000000000..6213c0cf8 Binary files /dev/null and b/netbeans.apache.org/src/content/wiki/info.png differ diff --git a/netbeans.apache.org/src/content/wiki/keymapshinynewcategory.png b/netbeans.apache.org/src/content/wiki/keymapshinynewcategory.png new file mode 100644 index 000000000..c42f277e7 Binary files /dev/null and b/netbeans.apache.org/src/content/wiki/keymapshinynewcategory.png differ diff --git a/netbeans.apache.org/src/content/wiki/project-struct-i18n_TranslateNetbeansModule.gif b/netbeans.apache.org/src/content/wiki/project-struct-i18n_TranslateNetbeansModule.gif new file mode 100644 index 000000000..6cb07e37e Binary files /dev/null and b/netbeans.apache.org/src/content/wiki/project-struct-i18n_TranslateNetbeansModule.gif differ diff --git a/netbeans.apache.org/src/content/wiki/project-struct_TranslateNetbeansModule.gif b/netbeans.apache.org/src/content/wiki/project-struct_TranslateNetbeansModule.gif new file mode 100644 index 000000000..0b15d3821 Binary files /dev/null and b/netbeans.apache.org/src/content/wiki/project-struct_TranslateNetbeansModule.gif differ --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@netbeans.apache.org For additional commands, e-mail: commits-h...@netbeans.apache.org For further information about the NetBeans mailing lists, visit: https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists