From 1f09a9e89daa938d5e9a777d2e2c1530f2e97a50 Mon Sep 17 00:00:00 2001
From: Sean Madsen <sean@seanmadsen.com>
Date: Sat, 21 Jan 2017 10:17:42 -0700
Subject: [PATCH] civix - converting "note", "caution" etc to admonitions
---
docs/extensions/civix.md | 105 ++++++++++++++++++++-------------------
docs/img/check.png | Bin 1167 -> 0 bytes
docs/img/danger.png | Bin 1121 -> 0 bytes
docs/img/info.png | Bin 871 -> 0 bytes
4 files changed, 53 insertions(+), 52 deletions(-)
delete mode 100644 docs/img/check.png
delete mode 100644 docs/img/danger.png
delete mode 100644 docs/img/info.png
diff --git a/docs/extensions/civix.md b/docs/extensions/civix.md
index b46ce380..c18e508b 100644
--- a/docs/extensions/civix.md
+++ b/docs/extensions/civix.md
@@ -1,10 +1,10 @@
# Civix
->> 
-Note: This page started
-[here in the wiki](https://wiki.civicrm.org/confluence/display/CRMDOC/Create+a+Module+Extension).
-We have not yet transferred all of the script snipets, so you may wish to
-peruse this page as well.
+!!! caution "Notice: page undergoing migration"
+ This page started
+ [here in the wiki](https://wiki.civicrm.org/confluence/display/CRMDOC/Create+a+Module+Extension).
+ We have not yet transferred all of the script snipets, so you may wish to
+ peruse this page as well.
## Introduction
@@ -122,11 +122,11 @@ This creates three files:
The auto-generated code for the controller and view demonstrate a few
basic operations, such as passing data from the controller to the view.
->> 
-After adding or modifying a route in the XML file, you must reset
-CiviCRMs "menu cache". Do this in a web browser by visiting
-"/civicrm/menu/rebuild?reset=1" or by running
-`drush cc civicrm` if using Drupal & Drush.
+!!! note
+ After adding or modifying a route in the XML file, you must reset
+ CiviCRMs "menu cache". Do this in a web browser by visiting
+ "/civicrm/menu/rebuild?reset=1" or by running
+ `drush cc civicrm` if using Drupal & Drush.
**Edit In Place**
@@ -136,13 +136,13 @@ editing](/confluence/display/CRMDOC/In-Place+Field+Editing) API.
### Add a basic web form
->> 
-The form system is not well documented and may undergo significant
-revision after the CiviCRM 4.x series. In general, migrating basic pages
-will be easier than migrating basic forms, so you may want
-to consider building your data-input interface using basic pages, the AJAX API,
-and the
-[in-place editing](/confluence/display/CRMDOC/In-Place+Field+Editing) API.
+!!! caution
+ The form system is not well documented and may undergo significant
+ revision after the CiviCRM 4.x series. In general, migrating basic pages
+ will be easier than migrating basic forms, so you may want
+ to consider building your data-input interface using basic pages, the AJAX
+ API, and the
+ [in-place editing](/confluence/display/CRMDOC/In-Place+Field+Editing) API.
CiviCRM uses a typical web-MVC architecture. To implement a basic web
form, you must create a PHP controller class, create a Smarty template
@@ -174,10 +174,10 @@ This creates three files:
The auto-generated code for the controller and view demonstrate a few
basic operations, such as adding a <SELECT\> element to the form.
->> 
-After adding or modifying a route in the XML file, you must reset
-CiviCRMs "menu cache". This can be done in a web browser by visiting
-"/civicrm/menu/rebuild?reset=1"
+!!! note
+ After adding or modifying a route in the XML file, you must reset
+ CiviCRMs "menu cache". This can be done in a web browser by visiting
+ "/civicrm/menu/rebuild?reset=1"
### Add a database upgrader, installer and uninstaller
@@ -213,16 +213,16 @@ you can execute the upgrades through the web interface by visiting the
"Manage Extensions" screen. This screen will display an alert with an
action-link to perform the upgrades.
->> 
-The "upgrader" class is a wrapper for
-[hook\_civicrm\_upgrade](/confluence/display/CRMDOC43/Hook+Reference)
-which aims to be easy-to-use for developers with Drupal experience. If
-you need to organize the upgrade logic differently, then consider
-providing your own implementation of hook\_civicrm\_upgrade.
+!!! note
+ The "upgrader" class is a wrapper for
+ [hook\_civicrm\_upgrade](/confluence/display/CRMDOC43/Hook+Reference)
+ which aims to be easy-to-use for developers with Drupal experience. If
+ you need to organize the upgrade logic differently, then consider
+ providing your own implementation of hook\_civicrm\_upgrade.
->> 
-Only use the upgrade system to manage new SQL
-tables. Do not manipulate core schema.
+!!! caution
+ Only use the upgrade system to manage new SQL
+ tables. Do not manipulate core schema.
If you need to create triggers on core SQL tables, use
[hook\_civicrm\_triggerInfo](http://wiki.civicrm.org/confluence/display/CRMDOC/Hook+Reference).
@@ -272,8 +272,9 @@ This is the simplest scenario.
Start by creating a custom fields using the web interface and then export
them for use with the extension:
->> 
-Before you begin verify that civix is connected to your instance of CiviCRM by running `civix civicrm:ping`.
+!!! note
+ Before you begin verify that civix is connected to your instance of
+ fCiviCRM by running `civix civicrm:ping`.
- On your development instance of CiviCRM, create the new custom
fields using the web interface. Note the unique ID of the custom data
@@ -370,14 +371,14 @@ function myextension_civicrm_post($op, $objectName, $objectId, &$objectRef) {
}
```
->> 
-When you first created the skeletal project, several hook functions were
-auto-generated in `myextension.php`. These functions are usually about
-one line long – they simply delegate the work to another function. For
-example `myextension\_civicrm\_config()` delegates work to
-`\_myextension\_civix\_civicrm\_config()`. You should feel free to add
-more code to `myextension\_civicrm\_config()`, but you should preserve
-the call to `\_myextension\_civix\_civicrm\_config()`. <!-- fixme! why?? -->
+!!! note
+ When you first created the skeletal project, several hook functions were
+ auto-generated in `myextension.php`. These functions are usually about
+ one line long – they simply delegate the work to another function. For
+ example `myextension\_civicrm\_config()` delegates work to
+ `\_myextension\_civix\_civicrm\_config()`. You should feel free to add
+ more code to `myextension\_civicrm\_config()`, but you should preserve
+ the call to `\_myextension\_civix\_civicrm\_config()`. <!-- fixme! why?? -->
### Add a resource file
@@ -495,11 +496,11 @@ Get started by accessing the `civix` help:
civix help generate:api
```
->> 
-Action names must be lowercase. The javascript helpers `CRM.api()` and
-`CRM.api3()` force actions to be lowercase. This issues does not present
-itself in the API Explorer or when the api action is called via PHP,
-REST, or SMARTY.
+!!! note
+ Action names must be lowercase. The javascript helpers `CRM.api()` and
+ `CRM.api3()` force actions to be lowercase. This issues does not present
+ itself in the API Explorer or when the api action is called via PHP,
+ REST, or SMARTY.
You can make your API code with a command in this pattern:
@@ -522,8 +523,8 @@ For use with CiviCRM 4.3, you can also add the "–schedule" option (e.g.
### Add a new entity
->> 
-This functionality is considered "experimental and incomplete".
+!!! caution
+ This functionality is considered "experimental and incomplete".
You may have a need to create a new entity that does not exist in
CiviCRM. For this, you can use the command `civix generate:entity`
@@ -578,9 +579,9 @@ long as you follow a few basic conventions.
The following steps will create and run a test in your extension.
->> 
-Before preparing unit-tests with extensions, you must first
-[configure you personal testing sandbox](/confluence/display/CRM/Setting+up+your+personal+testing+sandbox+HOWTO) and enable your extension on the sandbox.
+!!! note
+ Before preparing unit-tests with extensions, you must first
+ [configure you personal testing sandbox](/confluence/display/CRM/Setting+up+your+personal+testing+sandbox+HOWTO) and enable your extension on the sandbox.
Explore the full options with:
@@ -614,8 +615,8 @@ how to write a test class:
- Review the example code in
[org.civicrm.exampletests](https://github.com/totten/org.civicrm.exampletests)
->> 
-The following instructions are deprecated. Updated instructions coming soon.
+!!! caution
+ The following instructions are deprecated. Updated instructions coming soon.
```bash
# Check if civix can connect to the civi api
diff --git a/docs/img/check.png b/docs/img/check.png
deleted file mode 100644
index 09335f512b0f25297089d982f7c96dd13be3d73d..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001
literal 1167
zcmV;A1aSL_P)<h;3K|Lk000e1NJLTq001BW001Be1^@s6b9#F800004b3#c}2nYxW
zd<bNS00009a7bBm000XU000XU0RWnu7ytkSF-b&0R9J=Omt9O;MHI*XGxzR=T}msE
zwiZ%KVhX8HAlg0{n;LyG`czD+2~s~Enh?X6i4RRo4DksyO+~1tMx$a%<4035#@J{o
zjfoF!SxQ@E3tD)wT@ql4yDU3<=Nuo{UG{Q!VG&GBJWuzY`Op0RGjn!!F7SU3vF;uW
zQ8(OC3LBLysR#fB$vG*_fdApQ|NPesR9|b`XOK9~%twTjdopQ=F)0L}XUGq49ymF+
zDF*8N9c5b6I}-A_T+M>O5IAdsUmH4j>h3=_P<N&MX=e06ilUt1&X@tHapb_eKV%cg
zYz_Obw7<a20~>$?KnX#9S97(!F`FRc3M|c>2OwougX;+bw88w;^@FD_u4$mo-%+L&
z-I9jfwi)nbFw-pC{NT+;x`XL?*9^(V$<2lXfDp169`h|%KK-ToTH8K@<>*FXJI!qf
z+Vk!PVwNUV4L{U9o=iDbK*UAMM&U0NKY@?RUqOwx+}$XJptxvuq*6}|AtXJ!QFv4F
zVfdtluF~hRKi_>`X~B+PM9M(ja7U?-M)5}B$?ysbC+=^6M;H#BA&njNLoM4~26T+;
zHwz8`^YI8y+&F_c*)F|^idvTeQt_H>fEw>^ROjzr7rfQqgFko%5bmQ!kxsEv1_aT4
znE<u<73eB$LRV>%%S0x4C;`9YnS-%4Kl6-;Qm5;35o*L%>gv4}=qhW3S6GR{S~igl
z-sbPYq$dQkFbf<2D@w7<lqp+H7;tvlYwbdw@TA_8CN4)t@noU1WKwW*4#p~Q0MJpo
zoqS#{!oTdRY?DLSf9EHhp7_?0^GPcsymcr6&$jG|V4Fb7_PY%1Dyf*D1*Ou(W|0?X
zgFmBpVj$~)N%+)id!80{I2IkhQ9kK1F!*?<t)j6@4z&=lc5Fd^a1cEc-?-r_yacyG
zIl;jI#neS~cBYov`De7K-=m0fc1oBy7rg9PiI57T)!&OLYYs+X-r8^g6j2b1)SI4j
z7#JU^_}&ghegknv6aB$Ky#M<^8a%XS!6kz=LCr4=k2QSqqhsim!o6P|J8TwMgXZ=^
zcOx^@bQoJH50NdL^UMJtelN_d79SmJ==(K2Z>$u~esO)Oq@gySH64;Z%V|Og7zGxT
zNiYg>hubp|P&EE#;F-_*R<>olas_ncb&9BS_H-DWVLPPP$_dPx5T6c1hhv`yM)q`O
z(qz3AKX&O2^WN-aHw@YADe^)3tlYmMc&Xs*`6x(J_ia1!Dvo}s*JU6XmFJHg1)*E!
znLCYwJV>7h!gTH264xf^1qBK#Xj|Wvf?EPdKK**N@pGC})rFS}nRT<!;y5H85QbPX
zArsw+!Ep^H27$&U%QJ@deK30Tba<_?*Y|D65LFjmtYH?11h^7F@&Yppa6qu}%UHw5
hw;;f)4fCIhzX2*+%|g;V>yrQg002ovPDHLkV1nG~5I6t;
diff --git a/docs/img/danger.png b/docs/img/danger.png
deleted file mode 100644
index 84c54be0bf8aa30fae0c75c2cc9ab53084d7f456..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001
literal 1121
zcmV-n1fKheP)<h;3K|Lk000e1NJLTq001BW001Be1^@s6b9#F800004b3#c}2nYxW
zd<bNS00009a7bBm000XU000XU0RWnu7ytkS14%?dR9J<rS4(djRTTct8BaX1oy4`B
z*lkfF(ozHzC5kGNj>036D5$XDp-O<=O&8rFBo;vk5OkBO8-7DIafDKYRH>Cf%C1BO
zbrF*#p$SM8&`5<wjysOydsx^GevCc0Nxt2^_ssded+&MNA!y=uI^C;8-Xx-F5g8%o
zVWm`0b$OG3H6qF>V9@|>Ow7$~>i8u;gInqJ(*(@0$a`S6H1$3LFpqM1_VoPxuX_@3
z=i<dsu~4|gz=r?~P2y(kh{)F{7C*PIU3;W0;HUHFPwa?%$H23DByPrv0Pon2v+65g
zDV-h@qVE|<91wX0A{%9qGn3iua$5n_o&R{?<aHv1$gV$$T>;CPOn3|US@+n(M?-kx
z)gurA?)`8NTYq|9u@_dvb;oNl!L`{f;458n!!j`R)*yoMAgn|XLvIhlu(ad!d9ti8
zYXb%<saB14EhO!J1nLL_-2n{P1G=9Bz(-4&%<)|T1k6A))vSIC@zHq8d}8zvtVB>(
zK!8MM0D$hCJJ(k-&A+sY3=y7ucMv^85zpn#-}6}i_76bB*OgMLAeNQlZPR>1x5D)u
zi!_jb>imn(vJZF1y+aZ74ttAh1~Z2Y*F75`qG_!U3_|kdRKwib{hb!O)GJBk*Yi+i
z|5Fg6X%>+Y9RabiIIL)wubmYQA~qJ&aS0I_VPYQkGc+S6lBfH%oB}{{ydQy3z}Jq6
zhPke#ws$x=0K;TIvt1ZL1IbDMv{XcWzFtFzLx?>W^;|oaGV#=5@14d^M$w(@_7xET
zunC|wu>pW8LDdeIKIm)jnFy(=6xP03Z=04Z@{kEwYv&{SOcaqLq4p#`=s6lf^h9sl
zbtQ6_i74l_Xml}BFLu7i<~rbo<V#6#!28`pL^)Q#qSs>LR2*Fqv!ion0#oOF5B8c!
zoNC+M7Xt=xLn?2$hKPxc`sZ@T7^wF(atQZtZ#2v)r3%}n(oL?uUgxzu?GfT}1H?Qx
zwXl${q+z){3!tH{=B}?{>mPUD<XaD1{BnK0VNNMkQp}fux);$>I(>zRKCX=m<uV?)
zE_O6JTPFmF5VI_VjQ_j60JFB^d;(PJ005vX9R8w|&%X}llK>Dh41~hreUW=Xl*$!N
zbN5Bma63zx%yAM~0+D{<e+($#Z&NAzg>3e2ZLXmd+m5qZ7C8fvjn>ciPi_FO)swdf
z0D#GCc3FsQ04oPYE=uK0rR)jEX(@W1&B%6~RdL;M09VkI9ghR0R7rr@qG?Vv@4N=z
zpVMkw%qWrfnOUnbD5VO-Jg1m1PhP$HTPIsz0X5vZaG}R=-Lq2tJ!hg}MbrmWx|$NX
nTkR{0#qI5zQws}u9l!qp4yaoAZ}dYt00000NkvXXu0mjfi*5hB
diff --git a/docs/img/info.png b/docs/img/info.png
deleted file mode 100644
index 87a4d2681f2bf86086c089a158b506922cd030e7..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001
literal 871
zcmV-t1DO1YP)<h;3K|Lk000e1NJLTq001BW001Be1^@s6b9#F800004b3#c}2nYxW
zd<bNS00009a7bBm000XU000XU0RWnu7ytkR2}wjjR9J<@mrqDkQ543%bKV^nN}yp1
z1yR<bg$t`u+P0b6L=YrNEkh(NO$rR9VM+;tP|2`A%N7Mj5ws9pxD4b~ATCl$5n7lc
zNQA+7-#IOu8K;@j`()B@b^o3F{kZSmd+q~vSmZh|KB+~)iakw)m?%XVQU#zi)x8Yx
zS7G%@FzOYX;Y2kh3j)wFp=Bm%+ZB3+!MojXWl5DDdB*f6j?(g$0dD*DVj$AT%;j#z
zIT#`f1a9rFGcQ8{#K+V~i5&#f<*gX!fj}Qm&zP2>dI~lLh>xiWb_K5pI9mwwj1;dw
z&wBN_5S&L_Vh0Ou4giF6N2=_j{N^lmeXy5E@!WY*kvSnK6CZF5Q9(oYp2(~~$Ap$?
zAid7!!1cRzMF)Cniw>&dhBE-9KmJM6$9EmTByGF%ZWo!m8#R6DYIm)9Adqh^q0C$%
z*0%it5TDc{g<f$o2OzndSCv@ZFEvqZZuB*h0SH#?Y4=M8VCMZ@zP*_?@A?pQfOubs
z`0@(aQvhH9fCw?y;Is(1-#MOaV}Dh{m}kYu0K78*AWBhoUchxR^WN}LYZ9d>kop9v
z#1cxXc*BM(EpvqeZ$lHP9LfM-J*zp(i*Qq-h8OM~<3-PKV`zYsXWmWdszePh{H^RN
z1~eOB!<6}7#A}`@0RFn&{sR7z0T5Pyy8&3&JQ)B;FuL6U3XEg`ykav9$kMjCi!6FS
z%{oA$nv$xNm#hDml=xxdB-soA0C>jqiiq=Zy7f`^WXkWQ(lt&X^IpLH>H41!l5u;1
z7%yBVQsAv;xH0()<QaKJgfmWYs^`0FBd`7n005o->L7!fTqX-Efe!RUBUiKA@@~TE
z8PlSQH-$D=V8|Rdt-0-a07LZ@OwD@d0ew;^bAb*_&3Fw7BFXLBFbQ{!+Y1WmXXc8n
z8Oyu}zIG>ShW<5X(^o+Jla`9LZKB#7;?1}S<^i_cmpH*cHX7>u3~BT=QmHnkiWo6P
xMdUEDeomSBi;DV082L_S<Y|;vUFY6W{RZnuD_q%vMz8<?002ovPDHLkV1nBrf1LmT
--
GitLab