Setting up the Wordpress Plugin - Revision history

Stuarteve: /* Example 2 - A transcluded subform */

2014-10-14T10:27:32Z

‎Example 2 - A transcluded subform

Stuarteve: /* Example 1 - A link to a Context */

2014-10-14T10:27:11Z

‎Example 1 - A link to a Context

Stuarteve: /* Example 1 - A link to a Context */

2014-10-14T10:26:49Z

‎Example 1 - A link to a Context

Stuarteve: /* Usage */

2014-10-14T10:25:36Z

‎Usage

Stuarteve: /* CSS Settings */

2014-10-14T10:19:33Z

‎CSS Settings

Stuarteve: /* Set Up */

2014-10-14T10:19:15Z

‎Set Up

Stuarteve: /* ARK Settings */

2014-10-14T10:17:23Z

‎ARK Settings

Stuarteve: /* ARK Settings */

2014-10-14T10:05:39Z

‎ARK Settings

Stuarteve: /* ARK Settings */

2014-10-14T10:05:21Z

‎ARK Settings

Stuarteve: /* ARK Settings */

2014-10-14T10:05:04Z

‎ARK Settings

@@ Line 59: / Line 59: @@
 Shortcode format to use: [ark_tc mod=itemval sf=subform_name ark=quickname w=400 h=200]
-The post text could read: <pre>"When we look at the photos for this context, you will see the dark-brownish smear [ark_tc cxt=MNO12_123 sf=cxt_site_photo]"</pre>. This will render the text, with the Site Photo subform replacing the location of the shortcode.
+The post text could read: <code>"When we look at the photos for this context, you will see the dark-brownish smear [ark_tc cxt=MNO12_123 sf=cxt_site_photo]"</code>. This will render the text, with the Site Photo subform replacing the location of the shortcode.
 The plugin does not check the presence of the subform or the itemkey/itemval pair, so if you put something in incorrectly it will likely print out an ARK generated error message complaining that the form does not exist.
 As with the hyperlink shortcode, you can specify which ARK the form should come from (if you have more than one saved in your settings), and you can also specify a width (w) and height (h) in pixels if you want to change the size of the transcluded subform.

@@ Line 47: / Line 47: @@
 Shortcode format to use: [ark_link mod=itemval]
-In the Visual editor of Wordpress for a post you could write the following: <pre>"[ark_link cxt=MNO12_123] is a really interesting context, mainly because it is a good example of a pit".</pre> When this post is previewed it will replace the shortcode with a hyperlink to Context MNO12_123.
+In the Visual editor of Wordpress for a post you could write the following: <code>"[ark_link cxt=MNO12_123] is a really interesting context, mainly because it is a good example of a pit".</code> When this post is previewed it will replace the shortcode with a hyperlink to Context MNO12_123.
 If you have more than one ARK, then you will need to use the quickname to refer to the one you are interested in. This should be done using an extra attribute called 'ark'. Please note this attribute should come after you have stated the itemkey/itemvalue pair:

@@ Line 51: / Line 51: @@
 If you have more than one ARK, then you will need to use the quickname to refer to the one you are interested in. This should be done using an extra attribute called 'ark'. Please note this attribute should come after you have stated the itemkey/itemvalue pair:
-<pre>"[ark_link cxt=MNO12_123 ark=Mins] is a really interesting context, mainly because it is a good example of a pit from the Minories excavation. However, a similar context was found in the Prescot Street excavation ([ark_link cxt=PCO06_12 ark=Prescot])".</pre>
+<code>"[ark_link cxt=MNO12_123 ark=Mins] is a really interesting context, mainly because it is a good example of a pit from the Minories excavation. However, a similar context was found in the Prescot Street excavation ([ark_link cxt=PCO06_12 ark=Prescot])".</code>
 Please be aware the plugin does not check if the ARK item exists, so take care when filling in the values otherwise you will end up with dead links.

@@ Line 47: / Line 47: @@
 Shortcode format to use: [ark_link mod=itemval]
-In the Visual editor of Wordpress for a post you could write the following: "[ark_link cxt=MNO12_123] is a really interesting context, mainly because it is a good example of a pit". When this post is previewed it will replace the shortcode with a hyperlink to Context MNO12_123.
+In the Visual editor of Wordpress for a post you could write the following: <pre>"[ark_link cxt=MNO12_123] is a really interesting context, mainly because it is a good example of a pit".</pre> When this post is previewed it will replace the shortcode with a hyperlink to Context MNO12_123.
 Please be aware the plugin does not check if the ARK item exists, so take care when filling in the values otherwise you will end up with dead links.
@@ Line 53: / Line 57: @@
 ====Example 2 - A transcluded subform====
-Shortcode format to use: [ark_tc mod=itemval sf=subform_name]
+Shortcode format to use: [ark_tc mod=itemval sf=subform_name ark=quickname w=400 h=200]
-The post text could read: "When we look at the photos for this context, you will see the dark-brownish smear [ark_tc cxt=MNO12_123 sf=cxt_site_photo]". This will render the text, with the Site Photo subform replacing the location of the shortcode.
+The post text could read: <pre>"When we look at the photos for this context, you will see the dark-brownish smear [ark_tc cxt=MNO12_123 sf=cxt_site_photo]"</pre>. This will render the text, with the Site Photo subform replacing the location of the shortcode.
 The plugin does not check the presence of the subform or the itemkey/itemval pair, so if you put something in incorrectly it will likely print out an ARK generated error message complaining that the form does not exist.

@@ Line 31: / Line 31: @@
 It is also possible to set some custom CSS for the transcluded subforms, which will override the CSS used by the parent ARK. You can type the CSS statements within the CSS box. For example, if you want the headers of each form to turn 'red', you could use: <pre>div.sf_nav h4 {color:red};</pre>
-[[File:File:Ark trancluder2.png|500px]]
+[[File:Ark trancluder2.png|500px]]
 ====Save the Settings and check the ARK connection(s)====

← Older revision		Revision as of 10:19, 14 October 2014
Line 30:		Line 30:

	It is also possible to set some custom CSS for the transcluded subforms, which will override the CSS used by the parent ARK. You can type the CSS statements within the CSS box. For example, if you want the headers of each form to turn 'red', you could use: <pre>div.sf_nav h4 {color:red};</pre>		It is also possible to set some custom CSS for the transcluded subforms, which will override the CSS used by the parent ARK. You can type the CSS statements within the CSS box. For example, if you want the headers of each form to turn 'red', you could use: <pre>div.sf_nav h4 {color:red};</pre>
		+
		+	[[File:File:Ark trancluder2.png\|500px]]
		+
		+	====Save the Settings and check the ARK connection(s)====

	Provided everything is working, once you have saved the values - you can click the Get ARK Info button. This includes the current name and version of the ARK and also the available modules and the names of the subforms (per module) that are available for use with the plugin.		Provided everything is working, once you have saved the values - you can click the Get ARK Info button. This includes the current name and version of the ARK and also the available modules and the names of the subforms (per module) that are available for use with the plugin.

@@ Line 19: / Line 19: @@
 This form should be self-explanatory. Please ensure that your ARK url does not have any page names in it, you should be just entering the base URL. For example, 'http://www.myark.com/ark/' NOT 'http://www.myark.com/ark/micro_view.php'.
-You will only need to enter username and password if you do not have anonymous logins setup. **PLEASE NOTE:** this username and password MAY be sent plaintext and give someone access to your ARK - so it is advisable to set up a special locked-down account on ARK that does not allow edits and only has limited access.
+The Quickname of the ARK is used to refer to a specific ARK, especially if you have more than one registered. If you are only using one ARK the quickname is not mandatory.
-Provided everything is working, once you have saved the values - you can click the Get ARK Info button. This includes the current name and version of the ARK and also the available modules and the names of the subforms (per module) that are available for use with the plugin.
+You will only need to enter username and password if you do not have anonymous logins setup. ''PLEASE NOTE:'' this username and password MAY be sent plaintext and give someone access to your ARK - so it is advisable to set up a special locked-down account on ARK that does not allow edits and only has limited access.
-If this information does not appear - Wordpress couldn't make a connection with your ARK installation. The best way to debug this is to open this url in your browser: http://www.myark.com/ark/api.php?req=describeARK&handle=YOUR_USERNAME&passwd=YOUR_PASSWORD. This should return an array with the version and name of the ARK, if it returns any errors then you'll need to fix those before you can properly use the plugin. Check out the [[API documentation]] for further information.
+If you want to have access to more than one ARK within your Wordpress installation, you can add up to 4 other ARKs, using the Add Another ARK button.
 [[File:Trancluder plugin1.png|500px]]
-If you want to have access to more than one ARK within your Wordpress installation, you can add up to 4 other ARKs, using the Add Another ARK button.
+====CSS Settings====
 ===Usage===

@@ Line 25: / Line 25: @@
 If this information does not appear - Wordpress couldn't make a connection with your ARK installation. The best way to debug this is to open this url in your browser: http://www.myark.com/ark/api.php?req=describeARK&handle=YOUR_USERNAME&passwd=YOUR_PASSWORD. This should return an array with the version and name of the ARK, if it returns any errors then you'll need to fix those before you can properly use the plugin. Check out the [[API documentation]] for further information.
-[[File:Trancluder plugin1.png]]
+[[File:Trancluder plugin1.png|200px]]
 If you want to have access to more than one ARK within your Wordpress installation, you can add up to 4 other ARKs, using the Add Another ARK button.