Plugin Directory

Changeset 3024427


Ignore:
Timestamp:
01/20/2024 10:55:35 AM (2 years ago)
Author:
dutchigor
Message:

Tagged first release and updated readme

Location:
image-map-connect
Files:
2 edited
1 copied

Legend:

Unmodified
Added
Removed
  • image-map-connect/tags/1.0.2/readme.txt

    r3024415 r3024427  
    1414== Description ==
    1515
    16 ## What is Image Map Connect Plugin? ##
     16= What is Image Map Connect Plugin? =
    1717
    1818Image Map Connect allows you to add any image to your WordPress website and make it an interactive image map. On the image map you can:
     
    2828
    2929
    30 
    31 ## What Can You Use the Plugin for? ##
     30= What Can You Use the Plugin for? =
    3231
    3332Among other things, you can use the plugin provide an interactive
     
    4039
    4140
    42 
    43 ## Key Features ##
     41= Key Features =
    4442
    4543- Create unlimited amount of image maps, layers, and markers
     
    5755
    5856
    59 ## Help and Support ##
     57
     58== Help and Support ==
    6059
    6160You can contact us in two ways at the moment:
     
    6968== Frequently Asked Questions ==
    7069
    71 =What is an image map?=
     70= What is an image map? =
    7271
    7372Image map is an image with clickable areas that can be used e.g. to navigate to different pages of the same website.
    7473
    7574
    76 =Can I add an image map to an archive page?=
     75= Can I add an image map to an archive page? =
    7776
    7877Yes. In a block theme, you can include the image map in the archive template. If you embed it in the query loop block, only markers for the posts in the archive will be displayed on the image map.
     
    8180
    8281
    83 =Can I make the image map style compatible with my theme?=
     82= Can I make the image map style compatible with my theme? =
    8483
    8584Yes. The image map size, borders and background color are configurable. The popup text styling is taken from your theme by default and you can further modify the style to align with your theme.
     
    104103== Installation ==
    105104
    106 ## Install Image Map Connect within WordPress ##
     105= Install Image Map Connect within WordPress =
    107106
    1081071. Visit the plugins page within your dashboard and select ‘Add New’
     
    112111
    113112
    114 ## Install Image Map Connect manually ##
     113= Install Image Map Connect manually =
    115114
    1161151. Upload the ‘image-map-connect’ folder to the /wp-content/plugins/ directory
     
    119118
    120119
    121 ## After activation ##
     120= After activation =
    122121
    1231221. Click 'Image Maps' in WordPress sidebar menu
     
    129128
    130129
    131 == Development ==
     130== Changelog ==
    132131
    133 ## Source Code
     132### Contributing ###
     133
     134= Source Code =
    134135
    135136The code can be found on [Github](https://github.com/Flare-Hub/image-map-connect-plugin)
    136137
    137138
    138 ## Development environment setup ##
     139= Development environment setup =
    139140
    140141This plugin makes use of both Node and Composer as development tools. For this reason, ensure both are installed and execute the following commands after cloning the project:
     142
    141143- `npm install`
    142144- `composer install`
     
    147149
    148150There is also a Docker configuration included to aid the development. If you wish to use this, make sure docker in installed and run `npm run start` to:
     151
    149152- Start the docker containers
    150153- Execute wp-scripts start
     
    152155
    153156
    154 ## Folder structure ##
     157= Folder structure =
    155158
    156159This is a brief description of the folder structure used in this plugin.
    157160
    158 ### .vscode ###
     161**.vscode**
    159162plugin recommendations, settings and debug configuration for VS Code.
    160163
    161 ### app ###
     164**app**
    162165The javascript source code.
    163166
    164 ### docker ###
     167**docker**
    165168The docker configuration and setup files.
    166169
    167 ### inc ###
     170**inc**
    168171The php classes and helper files.
    169172
    170 ### releases ###
     173**releases**
    171174The files to send to the wordpress plugin library.
    172175
    173 ### scripts ###
     176**scripts**
    174177javascript development scripts
    175178
    176 ### root ###
     179**root**
    177180The root folder contains all the necessary configuration files for all the development tools used in this plugin:
     181
    178182- Git
    179183- ESLint
     
    184188
    185189
    186 ## Dependencies ##
     190### Dependencies ###
    187191
    188192This plugin makes use of multiple independent open source packages, both from NPM and from Packagist. You can find a list of all the projects we have the pleasure of including on this plugin in the composer.json and package.json files. For a more comprehensive list, including all the packages that these packages use, see composer.lock and package-lock.json.
    189193
    190194
    191 
    192 
    193 == Changelog ==
     195### Changelog ###
    194196
    195197= 1.0.1 =
    196 * Fixed Fixed: missing sanitization of REST API field updates.
     198
     199- Fixed Fixed: missing sanitization of REST API field updates.
  • image-map-connect/trunk/readme.txt

    r3024415 r3024427  
    1414== Description ==
    1515
    16 ## What is Image Map Connect Plugin? ##
     16= What is Image Map Connect Plugin? =
    1717
    1818Image Map Connect allows you to add any image to your WordPress website and make it an interactive image map. On the image map you can:
     
    2828
    2929
    30 
    31 ## What Can You Use the Plugin for? ##
     30= What Can You Use the Plugin for? =
    3231
    3332Among other things, you can use the plugin provide an interactive
     
    4039
    4140
    42 
    43 ## Key Features ##
     41= Key Features =
    4442
    4543- Create unlimited amount of image maps, layers, and markers
     
    5755
    5856
    59 ## Help and Support ##
     57
     58== Help and Support ==
    6059
    6160You can contact us in two ways at the moment:
     
    6968== Frequently Asked Questions ==
    7069
    71 =What is an image map?=
     70= What is an image map? =
    7271
    7372Image map is an image with clickable areas that can be used e.g. to navigate to different pages of the same website.
    7473
    7574
    76 =Can I add an image map to an archive page?=
     75= Can I add an image map to an archive page? =
    7776
    7877Yes. In a block theme, you can include the image map in the archive template. If you embed it in the query loop block, only markers for the posts in the archive will be displayed on the image map.
     
    8180
    8281
    83 =Can I make the image map style compatible with my theme?=
     82= Can I make the image map style compatible with my theme? =
    8483
    8584Yes. The image map size, borders and background color are configurable. The popup text styling is taken from your theme by default and you can further modify the style to align with your theme.
     
    104103== Installation ==
    105104
    106 ## Install Image Map Connect within WordPress ##
     105= Install Image Map Connect within WordPress =
    107106
    1081071. Visit the plugins page within your dashboard and select ‘Add New’
     
    112111
    113112
    114 ## Install Image Map Connect manually ##
     113= Install Image Map Connect manually =
    115114
    1161151. Upload the ‘image-map-connect’ folder to the /wp-content/plugins/ directory
     
    119118
    120119
    121 ## After activation ##
     120= After activation =
    122121
    1231221. Click 'Image Maps' in WordPress sidebar menu
     
    129128
    130129
    131 == Development ==
     130== Changelog ==
    132131
    133 ## Source Code
     132### Contributing ###
     133
     134= Source Code =
    134135
    135136The code can be found on [Github](https://github.com/Flare-Hub/image-map-connect-plugin)
    136137
    137138
    138 ## Development environment setup ##
     139= Development environment setup =
    139140
    140141This plugin makes use of both Node and Composer as development tools. For this reason, ensure both are installed and execute the following commands after cloning the project:
     142
    141143- `npm install`
    142144- `composer install`
     
    147149
    148150There is also a Docker configuration included to aid the development. If you wish to use this, make sure docker in installed and run `npm run start` to:
     151
    149152- Start the docker containers
    150153- Execute wp-scripts start
     
    152155
    153156
    154 ## Folder structure ##
     157= Folder structure =
    155158
    156159This is a brief description of the folder structure used in this plugin.
    157160
    158 ### .vscode ###
     161**.vscode**
    159162plugin recommendations, settings and debug configuration for VS Code.
    160163
    161 ### app ###
     164**app**
    162165The javascript source code.
    163166
    164 ### docker ###
     167**docker**
    165168The docker configuration and setup files.
    166169
    167 ### inc ###
     170**inc**
    168171The php classes and helper files.
    169172
    170 ### releases ###
     173**releases**
    171174The files to send to the wordpress plugin library.
    172175
    173 ### scripts ###
     176**scripts**
    174177javascript development scripts
    175178
    176 ### root ###
     179**root**
    177180The root folder contains all the necessary configuration files for all the development tools used in this plugin:
     181
    178182- Git
    179183- ESLint
     
    184188
    185189
    186 ## Dependencies ##
     190### Dependencies ###
    187191
    188192This plugin makes use of multiple independent open source packages, both from NPM and from Packagist. You can find a list of all the projects we have the pleasure of including on this plugin in the composer.json and package.json files. For a more comprehensive list, including all the packages that these packages use, see composer.lock and package-lock.json.
    189193
    190194
    191 
    192 
    193 == Changelog ==
     195### Changelog ###
    194196
    195197= 1.0.1 =
    196 * Fixed Fixed: missing sanitization of REST API field updates.
     198
     199- Fixed Fixed: missing sanitization of REST API field updates.
Note: See TracChangeset for help on using the changeset viewer.