From 934ee077e1aebce65b186992de30c1d23a76c5f6 Mon Sep 17 00:00:00 2001 From: Sydney Koke <84661720+sjkoke@users.noreply.github.com> Date: Thu, 19 Dec 2024 17:03:25 +0100 Subject: [PATCH] improve user guide (#41) Improve grammar and correct some text --------- Co-authored-by: Nicolas CARPi --- doc/img/export-options.png | Bin 0 -> 11337 bytes doc/user-guide.rst | 309 ++++++++++++++++++------------------- 2 files changed, 153 insertions(+), 156 deletions(-) create mode 100644 doc/img/export-options.png diff --git a/doc/img/export-options.png b/doc/img/export-options.png new file mode 100644 index 0000000000000000000000000000000000000000..dbb3f469f13e611e809266c05ebaec72455badb0 GIT binary patch literal 11337 zcmb7q1ymg0vnC{j;2tCd2yVe`@L<6PCrI$%?#?hFxXWOJJ42Ac-3jjQ5Zv8;^LxAh z_jdQ~p10fQ+^*_6U43r%y|-@HS6`^IqBJJjdo%KD%NEc4 zD^ML|w4D(Uuzvs35EGcONdFo!T%@#IZ0yY~jg4%y5V!#BimCYx|C?PKfs>!znrasO z*N*nj{m#ZtrlxiXrjp8TCQu9ngpUZal49x}`bW#|>I9mky=NzcIAW3nhb{772_h?Q z^l`dZzAH`5$se}V&FPd>WPOj6o!aDaGv>P{G}esCp+Y%4es~))s5*`73KH3I5E^P> zu4=kSg?hX1kW5#Zk7A%uuB0xw_~EQC%OnRVhXlx?1m-aS=@rx1^=JavV{_P1DdXsk z@Wd(c=qL%O{-vCI2Fki8=@~ao8XvMA?*mB#Z|kcI&_yio-!3)YMVK#bW|KQv0tHdd z&V2Nx=_o~v{#SR);J@w$J#K})r_*VuQQ-Lm%3BQUpuxk8TW+5Pqt4Ijo6H%j_vsA~ z4M$!rip3mkk->dg(esDWo#wD9Tv03WJl3yrW!1ut>qr?H83o~Lfg-yE%=E)squ#Mv z+kK(SxlKZpTn&{$4kx}yiTuUm&K7Tl4n@zNezJRKJ`%!e*<^#WTVN@ZKSLheJ#${W zDAhBI;bkU|erNW7si>&$Nf@B^g>>gdq0J;+Qp!?b{}eE9k`M>amym5*1G>+)B(r%QCAC*z+;hGT1B z8&tI!q0XvR8?&pc&G8i3PhqHWatVaJA4n+w;5BI;Zl(+!hDQIH6y)5KKtc25vL+hL z>U!Dy)|07gz3@{&34|QM*xj!pTE6FtL+SOowT@nOzL1EnhV0tS3Pt9la_HDgUHD$t z^~HKCd5yoYTjt7{h7Y1h%dnzaz&+W)`k_T2UEpg9e@cv(2S4HuX|Tm?k-#k&jmS@> zXXn2oMU=S`D;qKz|IbYL_bKu3N}h$4E=sHrKPPH74k`o(EtdWNq{OJV0N90u(z3EX zic3f+qy{LbMMh#?Uteo!YeRWKI7QdlwjLgUo8x6_^N}xyax#HJh`0?-I zmMS0lIe#IRk%1v3jo*2Fch_QpCSYBi>FZ%FApwD8t<5~pi-B#r2bi6m{ntI2m2lnP z$-zOU#z^W{AZpGHp?F@w)Y7&p4^TXr>;K-*|9FL?u3&71BoNN?^K(IXfXutUa&B%e znN=f=m!}m0Wqfs5o(%bwQkltijzPoi@7-g6gv2e9<^n>$rb*@LCSu;A8wLC`Tz&z8 zlvyG@HH9hKM?$-eM`Osx7BiHsiJ*#zMF;3uz(Syh^fnQl1iO+yq~RcIEf7hLfpxmf z{C;!S_*J*emui`Q#>@;s(VFa@%__-Puqlhu2?$S{;MWwl0`u@VfEB{>n}TWk{?1hR ziE62MzO27(!65<5*EevtqqA!VcCR&Re)eXx)mvmdFp;5OZ;alpFJ#aHp7isXti4WJ zr{IpybpAdgUM6>Ed^8=#&HuVeX*ee;e{UlIueF4I@5J#*(Gl5hzTa@NHh!XU40J}k zFZfw~*O>LGA&7$BW&N}?(1uK(a534AkhX2Bu;X1h@>npw&k5(-+EQbi)T6_FuINC$ zB^h%9!vtHYppg?f)NsDR&r*%LP<$bfOydi_`g_cU_?2FDhV?--wJF<2mwW0gg0mp>3g-;8_23tz9ZZ_CjR+O@N4(yb?Sr++%=^^DJ! z^QW7Fj)z87-E&mzYS5`y)4Dm&0+eBSZ}U|f$z`ucr7qrp$Cg|wZnN+f_Co982#Ibw zEvU(zZX6%+;Q;kL#${)O;Ywk%2c@@M~I@OWv#;+LQu+HwibDwp6FjzNOhHJW@m)Do%no`K{T7`|=@p<+R zL+64b%Jo6DS4`?v)hoK{IrB;hG7@nI7~;eiHXbDV{Hh0yTwkV=gW>JVlJ_*+2B)=8 z8y;7D%t;xP20LVzzv4+Te}oftH9abJ=LHHaR+pL`p-nG8-=x3alN%>LdllvgKX z__?fK;h5lq@^`7{;axe_2;|R!Jp%NmK6G4l20VxOwL^P zw6W!SqWsihM^2DGF(Gv)_Q0E6w4_(AOIp+E-&(&glikHtC*FA!1@8ug)){RZsTyg+ z-r>{n(A!rw9T0>;hpqp>zE~&ted4c*dA8N>KE3z=Ape=K!?-j_%rZL%neBcv8=r@` z(%Ocbpb@TNs!*e%1Jxe(p#A;ekqSCDmr2BtYv{=f+1nnH|tQ9A(wk&d) z414NJO1`YXvayY?k>fV|sLgocTH{m%0}qK}oI*QOKlg4$`hZLc_rekZ}R90>2NOC;IM;Y^<+&PQW@|CG@Qj^ z&mon80qWCx=J#gZb}m2>C)ZyatF5sCT;koVh@MO2U)mRRtEJWgj+(&3wH(xYna)Tp z*6-**w`5T#TD>DE_GZ|u(aX|04Wmi(!HkK=SivB7hZ8A{_ok{BILi4oJ#vK-Z*e?B z7*`4z=B;t5txbGRFon;jUM<{zLQscsC*}<%`{!iv5I;M6r+5K;H;MEW$_lu&%=wcT z2fzH`;=)OH)d)*0mFUf&m3e7ZdPYyMs_C&`suv5zqXiN%v+Yw2Ha@jS(U0fu`jnb+ zRqcTa>b?d4veaV&eT7cUk8sv3Qw|JY{E0ppRk4=Ue%^NpIk%1%soQXq9K} zeeVY4Rb6At90X|I^wgUv${*HQs%zv8>PGCZTrog;krNistdDRD+;zGJ7kC^i%Bl3| zNGAr!wVU5w2y&ttiAMp&eavWp;tZ0VGy&rOFN(-<0s=+6Upu7uyH!*hFl*bx_LaMi z+^}Od@r5v_lwPO(n#PEzZ>ZviWTENed~FGrBHW!ql}ejo$fwIh*I8&EZ%~jg$8pD0 zm$S^6)(;PjbCsQBlFq@z>&SKZZ1dH-+Enr~#Z9)fJ|$diuR|}y&%ay6>IsWS=J4T= z;++wtQU<)m*}%?Y1GVwux4FI|fncXV3fDTVsj2i=-S63temZ?U!cgL!=*dS~J;vg* z4ZAv@q4A$PFvD4hOXV`8rO(dBiShQbf|b>>K5GZ)eU;=Zd!auj3xxe zEyrozmqRET*)}Gcraovcs8L5x31xvzml;YdCt52?RqW(acdj(N6r}sR^}h7@zS9^rD1pQ$qU&kKm+| zv2mpSpC}qx2x|EoMG1Oqnu+uZpL&MN`J!hZG7b0I3Dr*-#40APb^#k~6`&&Vja0@G|js?(D6LUI~jRO!>u(3Gc2Fy&JiCH1uo>s0YeKXeE z2I`05D3FB;G=I(e3ezn^CP9Xa_}pi`(JV)>;kW|^q}jRE7;$QIKmOp>J(W%RGK1SX z`E98LX3E#v^^z09bo!c!#&lM~r_gin9C|GH+BDma^m!z%5`_@zp zTgb(|oAD|q8|=wBg)k5nARzH?HU7I zx9Fz&OOU^MG4YiKc7YeQ+<%)W*?XXF1yxwB*HzojBqNh+D@$j5pRR<=ag+2>eFRfM(w2dubkZmcPmGElik1A}P-2X9cz+Qc#JbP{RWe7Z!CnwKw zBhH~T6_?YUF59%DJi+BI%OSMW7eV={`D=i_=uH9edlfRO=b*qA8`fRrk=++7OgJzo z`MTP)*&^N={ebt-^mE{sFJd#QCGp;Aq_8~-z4e?nLQSO`8v0M4K1Cvj{c@RGXfIAO zLbbcyFLAZd-jcqzU+5--V{Q62CPjiJRUCnOPO#iL@Y#E~{*pu&1R%b&Y>-s5##B;oPcHWl zR7*^(6eu=yWUlfaQh%oCnbF^xx17ogAHzK}#9us_Dpbp$QDirs%=)ukET@#P?drJO z{H~3;^i-rZFn7^wVO)Zu66F^$9>FcO)SPy?zMozf}lSj z412zC%v84VvNr1+`y2sl+%U6h`c?db3PfkHj4l z%a25=V@0h)p@G=mbjBFryB$l#p_lo6)(Y1>ey5tf(I31GfV!#Z!G4fTN=!)cCsOW& z*Nt)9@RRmsu0np#f!&=;(Iu4P1p?xQaQC9VEiAeQG4hHmaai-l$+zozY~HBlm;6vA-S z>aZc#rZLVPezR+6XYFL2=j|@m%VR~DQTjs_-F3nIHe*G4%HQvX3OK{>QhYR7IM<+x zE;BoW67630LMNX9&OkvJnMK1RHXY5q*tCv^V+f`oc}&e3_LM8|4}pTI{1&f5|I35d z%+pG6*cMQ*xgcA)x1ppud1P~|1tv)O>cFNOHkS8x_`;fUtQss=)UQ7pJm8G%Sl)~s z>HPi(Vk^ht(JjuYkU5xktiOak9mfGD{hI2UZ?;k=k_grqs>`uXOWEjGGq>yukkWJD zeOVqPl4fdbg(s(M*l9;tMbS&py?3|9d-3)bZ+^qI;-hYIe%R+R8dZQP?t`=K zZGuOYAp5WU{NIzY|4O+7jem6~Z8H)r-=4Ur@4i?Zh9G&UfB?g z(v&pmm=UaSJQ^WhOmb-XpjhLd_k3H}``C$u$GdTDwU0tz_W#{kgpc>!jbbL$J)!dl-_((CQAOy z)>L?v=i5C&;K~|mo<0(>;1ar1u>lmOB=R9yspTcN>vn`sM5#2{U3jgU=z?|KZE-R6 zn8(4ZRRAgGD{Q`tNOOL#W2~MZ8HI&2?0L3&at%!z>W#cC!KE9(z9tMCQ9Xk%$={Dh ztBrR?0HUZXaK@TBk1_k}&vHx2@+XYJvYsTzHzlGY_-Fpo8ePW}nbhf`X!8J-h=O*`@Q1J(Umvu6xC--Q-W9_M2!^6nr#VQ7^*U33(0fh%@#JofYKs zsHe;Fl7X?@1KG$egryo1gz%zA-l?tD3EZK)5J!j`aWQlkajU5){;_kfLI>C&X(zpxACix<3Mc4>HGA5Lwc*(egTEn9UVp zNSq6UB69g!QG~GmI4D$vu&(R?6$ysZ=(gQokJ@Ff^~DN)AuUe9cq7C>_~5O})KrN9 zT~1{#HFwa>9IYnVxZl8ENTkcOoZnm;w$Qww_p-a%a=_MP>b8x{XPk&&P2l5n*=J9j zyUtcoA^rJ$7r3>UYr)?jSXO{7L+M)ESY5&yy@sxF%2bFgk;{DddPeW^|u_7TeDB%7En7P0?Mh*>_&Vd7FgpD>A34vN3l{JeAc$M8!tTZ{iFJL)E6& zbn+~x#Fgl)_WDX6B^|GJ#Ht_W>!WG6dX9}vJvU4p|Mn?kegi)K{q)Tw-PV3|an(AH zEq@S+nl_+4n1qd`PZx%P*>u@`2eN}?SLRxUFXTNeM|TQ0Zw$qKBiI|NOsEBBHUzD# z;G<9qH>3@&P3Q9{n&Hv3>sm*WdU$=OA&?Y+nz9^v;jc>KAB2U|u7Yi4BTXIws<=|(8 z=3*ZyjvYJ#_@P3fV{01b1iqsc+Sjy!apNX1)s{j|eSP~|q8qo8W>WWF9KFG%>KV^V zrH+ZNc?#%fmeanC2!<2ImIlpGgF8irZj4@_?AYqYefm1aQYECLz?Lx^Jk;vAyjS?0Aj-*N zuRT+3^~JgHYUo=_Wa?Fu@>q4U@*Ib+KA2=sPR%0zj~)^?fgM*u#Z~3+dD36iPzKnW zqBqZuKH5fMjghNagtsJY^0FXD1eYa!zJO;^@{JjLO!TIDLu+oo@jO@hdtnS}NG@7u z^hVPa`5QqyGr6Qr3xt7$LbnT%UGDc&#HV&wJm^8TMqTsQ7;KihpGH6bAvbV)Ym%)} zoQx)V29r&i3{<6cruDI+tZ5ewLs~_T{c+l+-MUHBI3WyO;1WX*v1gh-K`{~$ zdt|3@$(Csm{tRsVz?zX6z zYEi|oPEZ)_Ma&A7AF+iKB(CwyN>Fg3ILG7uk_1^*InTg0SiUP`$YKuCmv!)Ajyn_8 zIe3zT3g5dYsTWy!r$p&s0DZU36Th&PB+Ps_v*dy0N7@PtEKQ`SEi2z5SQ}_%A%tk8 zkVrE?)rQ-B6+Y{6wN7W;yw5@D)(~}?#7lq*4)u#aWDj8E!iJy?ikBv{7x8;S7(+5Y zD0IYm%)$TEfgU{9C*wacqWrNYybgrTxN`nVo!;|ZN8)qca-2k9^8Qu#OFA*Ct=tZb zT`98AXJEv7X?gr*qPVzIz}iSx4-fi7CJwDsBfR#rPNMz3oL~H=QeNL;8&T#v9&Pz} zs-!?s@bGS!(uSE!>KV~<$2$qB6tzU7e zut!Y;PFOk>7G3>x1)Q0^Iw{XNG|Pl(N5IA&9h2=2Q&G^!V^u^;VUUH!CO_EbTTfW& zPC0DsC!MG0CSh5ANE1FGU$oPvBPWGjc-{AHX}U2BZXDOh4f=}-XH)YLEWwUt6zixD z6Jv%!Y%CW#Vw<>bZ(9DCsuQ#Q)IVqH5c4P8DN`eMEJDwfuFG08P_WP_1$Z7#H`jwh zB?N2BAB-3aZWRj88%U~;oRbf)bS4W51m{_PHZ;5QpkpnnfECFqNlrSs-&oG%aLf0? zP19Ma74D})@Oih2`gH5iSv1{D%`zG1uqwV}gSMxZ!h(K{Br)YKND#6CfdX&)0!t0s&K-UyKE4zt(ETFrKs#X;_hM5ak~CV9+{O+A#;yl^+xz&6!BOX zdZXt!1j~3NVym%=OkGWu{TDPBzI{dcStpq@-;S%Ti<@=Zoigc}Q`FTGxS?STFwr3& z)t#yL5Y07RaEjr=2MtKZq>-FFcgR^K^Rx6q z+zm5~#HHg$aP&&2?db&{gOo?`Fa-2~vZb2~5WF7ngC=`UF?K@hc^<6lEqOw-g`kCq zAY3TC?1=1u-*;L5_slCc<*9dts$XHtZa7uo7O4qZ3QVE4ifE~>rpaJl2R@R>*n``dKD zS(7k>v(a;&$kgjRn$be3uNYGD%@cXx%1m5-<74-jS>bhg z2X}Q-|3bGn3UL2Ywp6P4Yqo+h$qObs(#1nujc!d*2exs`1`=b+`^Cfg3h$@S5)7KP zO8N4+O!W_TmQjksj6Zwvl8-Nk=+95Br#fCD~(PlLxKEtXnE z+){c%jEgY($(vcPp1IpUWFWmI`iAIJ)p|4L@mbQKr%D!u4q>hav+PRhsnF# z-o19}?Y41Iv)(^Z5%rpoPI=ybc&srikhgBJTLctkhrfCSsF>cPOhDkoZh;SDKNDhU)XM7Joc zej>L}K*zaMuWZV$1r`DVdeJ{zfK?w1e4V6h!v!uH%`XKgu z7>~y*JthJgox~*%kE?8nJ-(ZJ7=Az5 z*FR)lWs39~+D5mi;BkBUBsak@=gZ0pR)C25z2k&;)$;8E3&)EVkwU>BfU3pK}_utt`3mYxA_Z;%<=b^tI zgm;DpZ2Ggr`M^aCDl(~C$oYstQB$3fa1?s(PxoAOT~+=-TUYkRR8!9ZI?kE#O*UEC z;QYfSa0oq1Y7A{Q%SHF9e?Q>x|CD}7+c{<)GjZM#P)sNy*!ExRAup?pX z=rp1bq}$LBYwIc%{4%i2zd z8>1X~j0(Z5w5SX0LAb5-cQg7E-lA!n7z5%O;`5!>1Kg(kT zKYZg2>MmRfkcYq-S7+o0S5RLkSM5-_lMAoUKv$unFlGt&o+XoSG=qO*lj=Qx91{z# zHWTORP8bHaeg?5E>wDl*h+0jicH^4+jN;<&jU9mrlOZvUBl$iJ|HK+}8o}1F&2zH} z7=)Wt2ugXdtUWFO@4xL2T3=2qp9JB{YaIQVmD4mBqJx#FyBIY3%a_HW7KvfxMl@>s4tD2K+(4X=i$A^SJ9^4nx9iHk zJzB)6>b!)u&63vN9J*S*+s`}!*ep~ZPP{Dpa~pW#s5Tn}Zl?Q*F1Hb`pz}I(JH} zGq`AXR9$&Zpcv7zpi`kgjM;c}*)eSFKriw%{y~ZKluNsA#*YS9@6b3_+4scjy{}j) z3#2G85Yq%fr0Gm7tmNG}@GylE`|mEA$zN9!zAx8Zd~!1a@VSrX>1_PnF6uXQ8wnM> zM!)yg5IG(&NeZpcjY9Uun^{feyp*R(F-#Atb8o6y(ypU*PQ}3XJR)}QZq1fis5Yu4 zC-tDxWV6V?wwQ@`L=;n~68Do3 z;Sb7mblUWZUdF?yQ~=9wSU>2r_wBK}eO7RyQ;y_O2`W6i zSeDP)F|3WUz*R#&v}T&M9Y#qKGg?s6{?EdNgt+>kZ z^iV{wB9bz|aS$|+*gXGAo5K)egtTztW3lJ)%aEUE3zy^1O}PV=F3Yr0z&m)o%l#`O zWK2(?rGA2{mT%kEL#HaGjtb@<|IEGmq6l83j(?wkcG>ZK+gpTKAcn8TDCKU8AO7MK zrMAQ2WBwtJcpqp=0;r^IAU`tnTW#Tc=chgs|F=k>Nb=kp^32@u0p62*tDdZsjDh$e z4IiIIhi@T@L~)Xe*O6}lc914=gV91q+AVLw=XK6h63%Trmt0%F(1T<(f{4dto%At5 zcv@$MaUpJsWgx4LITNtVa?dtLO zt$M4v-lOZK#1C|ko0ZRFxOtOSve!VX!Va#NIb%NRsgFF_lH8zfktx+}5hbzev9+3RF? zk)dk;+rA-sAgr8qAq|&WXFW}E6w-A;!Vfx0txytITZc<68K3-}nSe(mkbwEOs1JTh zDiAeE;~dRVf!tP593=Wc4?O(iWhL;F z$bM$!N5sZOu=6A0=0GO>wp*&vQo|#g;|WCp{jDXAm;77K#iDTn>o0|2ypL5bpXAvB zdQ!J}kupuLlU*MVw36&r8t}<9v-`y$vJgwlJ9LSj;~vq_*Xc5P_O4VHo*}4H7CIWX zZ4#73g6i#qNCm$QZbtv8Lap98#WbmS?-MElWZ-rb-+L>(1CUq0x1G?jY9)Nn)5PWe z@w}$^r8=e0m7Z`$usq)@SE2U8;|JB&KkSd$>WWv((n1Q-HILo zTCMB-HO7YvkLZO44S$J-+3ND!BSiljoT}|ZV@6De@NOpXV4S-4$89R(+2fbLqoBQ6 zBo^(*v(6eJF$!tpt1z4qBM;DyU9KUgHp9rW9ij;m&`~pkR~U}xV3uT-rw3;FE) zj-JK(kZi^NlXE^`AENY$P3}2cYO;?*7>t5ci-jtozHGs1< zhJCBs`utlnFbO^TBUkD${`$uMnF9D9)VhDs?_$(3AssPHt3~gqG_35LiwNmRNl9P5 zdIcmxKNEX{gk)%JY}|P3FH^%lzqsgpvLgKW^rYr$PuU7Y_D2MR!NF`|55=hV6xMylp+X!pLKY2R8d*UX?y?i-*|sj>Vm`golE~#HoIQy3N9E7 zz&ZKc^AGPt@#23_UH|`q+5ZgH{wGV{3!+s%gV?3<;L%@NFM_O;qGXx4;m`jDVG1-y literal 0 HcmV?d00001 diff --git a/doc/user-guide.rst b/doc/user-guide.rst index dcdbedc..2dce051 100644 --- a/doc/user-guide.rst +++ b/doc/user-guide.rst @@ -1,7 +1,7 @@ .. _user-guide: ********** -User guide +User Guide ********** This guide is for Users. See also the guides for :doc:`Admins ` and for :doc:`Sysadmins `. @@ -16,7 +16,7 @@ While similar, they differ in the following ways: * Users can create Experiment templates but not Resource templates * Only Admins can create Resource templates -Both Resources and Experiments can have Tags and links, along with a Category and a Status. +Both Resources and Experiments can have Tags and links, along with a Category and a Status. Many of the options for creating and editing Experiment entries are the same as those for Resource entries. Experiments =========== @@ -27,9 +27,8 @@ Experiment entries are the core of the eLabFTW lab notebook. Select "Experiments .. figure:: img/user-show-mode.png - :alt: eLabFTW Experiments + :alt: eLabFTW Experiments - You can change the page layout by clicking the **Layout** button on the top right of the first listed Experiment: @@ -55,7 +54,7 @@ Set the scope to "*Self*" to display only Experiments that you created. Note tha You can create an Experiment by clicking the `Create` button on the top right of the screen. You will have the option of selecting an existing Experiment template or using a blank template. You will then be presented with a new Experiment entry. Experiment entries have two different modes: 'edit' and 'view'. By default, when an Experiment is created it will appear in 'edit' mode (you can see 'mode=edit' in the URL). -An Experiment entry can include many different types of information, such as: +An Experiment entry can include many different types of information, such as: * A title * ID and custom ID numbers @@ -70,59 +69,105 @@ An Experiment entry can include many different types of information, such as: The only required information is the title. +Toolbar +------- +For both Experiment and Resource entries, the top part of the page displays a toolbar with several available actions, as described below. +.. image:: img/user-view-toolbar.png + :align: center + :alt: view mode numbered -Edit mode ---------- +1. Go back +^^^^^^^^^^ +Go back to the index page. -Toolbar +2. Mode ^^^^^^^ -In edit mode, the top part of the page displays a toolbar with several available actions, as described below. +Switch between "edit" mode and "view" mode. + +3. Duplicate entry +^^^^^^^^^^^^^^^^^^ +Create a new entry with the same Title, Tags, text, and links, but with today's date and the Status set as "Running". A pop-up message will ask if you would like to copy the attached files to the duplicated entry. An «I» character is added to the title to indicate that it is a duplicate. + +4. Timestamp +^^^^^^^^^^^^ +When you click this button, a timestamp archive is created. This is a signed, legally binding snapshot of the entry that is stored alongside the attached files in an immutable archive. Timestamping an entry involves generating a full JSON export of the entry and creating a cryptographic hash of that data. This hash is then sent to a trusted third party: the TimeStamping Authority (TSA). + +The TSA acknowledges the existence of the data and sends back a signed token, which serves as proof that the data existed at that specific time. This process follows the :rfc:`3161` standard for Trusted Timestamping. + +The timestamped data and corresponding token are then saved in the "Attached Files" section of the entry as a zip file. This file is initially in an "Archived" state, meaning it is hidden from view by default. To view archived files, click the "Show Archived" button on the right side of the "Uploaded Files" section in edit mode: + +.. image:: img/show-archived-uploads.png + :align: center + :alt: timestamp archive + +This timestamp archive is immutable and cannot be modified or deleted. + +.. image:: img/timestamp-archive.png + :align: center + :alt: timestamp archive + + +5. Blockchain timestamp +^^^^^^^^^^^^^^^^^^^^^^^ +This button will perform the same action as a timestamp, except it will use blockchain technology and the service provided by the Bloxberg consortium. You can learn more about it here: `Bloxberg website `_. + +6. Export button +^^^^^^^^^^^^^^^^ + +.. image:: img/export-options.png + :align: center + :alt: view mode export dropdown -.. image:: img/user-guide-toolbar-edit.png +The Export menu allows you to save the entry in different file formats. +The ELN format is a new file format based on RO-Crate specification. It contains a special file (in JSON-LD) describing the contents of the dataset (one or several Experiments). It is designed and promoted by The ELN Consortium, an association of several ELN vendors that agreed on an interchange format for export/import of datasets. Learn more about it here: `TheELNConsortium on GitHub `_. -1. Go back to the list of Experiment entries -2. Switch to "view" mode -3. Duplicate the Experiment: make a new entry with identical content (except attachments). The new entry will have the default Status and today's date -4. Timestamp Experiment: create a signed, legally binding snapshot of the Experiment and store it alongside the attached files in an immutable archive -5. Export menu: export the Experiment in various formats (PDF, ELN, CSV, etc...) -6. Pin the Experiment: pin the Experiment entry to the top of the Experiment list -7. Lock/Unlock Experiment: prevent further editing. Only the user who locks an experient can unlock it. -8. Ellipsis menu: - - See revisions: the revisions system keeps track of changes to the main text of the Experiment entry - - See changelog: the changelog system keeps track of all other changes to the Experiment entry - - Archive/Unarchive: this removes the entry from the default list and adds it to the list of archived entries. - - Delete: perform a soft-deletion of the Experiment. This will mark the Experiment as deleted but keep it in the backend database. +7. Pin entry +^^^^^^^^^^^^ +Clicking this icon will make this entry appear on top of the list on the main page (pin entry). Use this to easily access frequently used entries. + +8. Lock/unlock entry +^^^^^^^^^^^^^^^^^^^^ +Use this to lock the entry and prevent further editing. Only an Admin or the user who locked an experiment can unlock it. + +9. Ellipsis menu +^^^^^^^^^^^^^^^^ + + - Transfer ownership: For entries you created, you can transfer ownership to a different user + - See revisions: View revisions to the main text of the entry + - See changelog: View the changelog for the entry + - Archive/Unarchive: Archiving removes the entry from the default list and adds it to the list of archived entries + - Delete entry: Perform a :ref:`soft-delete ` of the entry Date (started on) -^^^^^^^^^^^^^^^^^ +----------------- The date is set to today's date by default. You can edit it as you wish. The effective creation timestamp is stored in the backend database in another (read-only) attribute. ID -^^ +-- This attribute is not editable and corresponds to the unique (to that instance) immutable ID of the entry. Custom ID -^^^^^^^^^ +--------- This attribute (``null`` by default) can be set as a number after a Category is selected. Custom ID numbers will then be automatically assigned in an incremental fashion when new Experiments with that Category are created. One can also click the "Get next" button to fetch the next available Custom ID for entries of that Category. The Custom ID is displayed before the title. Title -^^^^^ +----- This is the title of the Experiment. A duplicated Experiment will have a «I» character appended to the title upon creation. Category -^^^^^^^^ +-------- You can assign a "Category" to each Experiment. Only an Admin can define the categories that are available for your team to use. Categories can correspond to projects, types of Experiments, and other strategies for grouping Experiment entries. You can easily browse groups of Experiments by Category from the main Experiment page. Status -^^^^^^ +------ This feature lets you set the 'Status' of an Experiment. The default status options are: -- Running +- Running - Needs to be redone - Success - Fail @@ -130,7 +175,7 @@ This feature lets you set the 'Status' of an Experiment. The default status opti These Status options can be modified by an admin via the admin panel. Tags -^^^^ +---- Tags allow users to easily group and sort Experiment entries. You can think of them as folders, but they are more powerful because each Experiment can have many different Tags. The Tag system thus enables efficient cross-searching. You can list all Experiments with a given Tag by clicking on the Tag or searching for it in the Tag search bar. To add a Tag to an Experiment entry, type the name of the tag in the Tag input field and press Enter or click anywhere outside the input field. You can add an unlimited number of Tags. Click on an existing Tag to launch a prompt that will allow you to remove it (in edit mode). Tags are common to each team. Autocompletion favors the reuse of existing Tags. @@ -139,37 +184,37 @@ You can list all Experiments with a given Tag by clicking on the Tag or searchin .. image:: img/quick_tags.* Permissions -^^^^^^^^^^^ +----------- The "Visibility" and "Can write" menus allow you to control who can access and change a given entry. Click the `Edit` button to view, add, or remove permissions. -Main Text -^^^^^^^^^ -Here is a space for you to freely describe your experimental setting, procedure, results, and any other information you wish to include about your research. In this rich text editor, you can add text with various formatting options, create tables, and add images, links, etc… +Main text +--------- +This is the space to freely describe your experimental setting, procedure, results, and any other information you wish to include about your research. In this rich text editor, you can add text with various formatting options, create tables, and add images, links, etc… .. image:: img/tinymce-editor.png :alt: Tinymce editor Inserting an image -"""""""""""""""""" +^^^^^^^^^^^^^^^^^^ -To insert an image into the main text, simply drag and drop it into the text editor. You can also insert an uploaded image by selecting "Insert in the text at cursor position" from the uploaded file menu (top right of attachment icon, three vertical dots). +To insert an image into the main text, simply drag and drop it into the text editor. You can also insert an uploaded image by clicking on the ellipsis menu on the file icon in the "Attached Files" section (three vertical dots on top right) and selecting "Insert in the text at cursor position". -Importing templates -""""""""""""""""""" +Inserting templates +^^^^^^^^^^^^^^^^^^^ -You can use the Import > Templates menu to select from existing Experiments templates and import them directly in your text, which allows you to compose an Experiment by merging several templates. +From the Insert menu in the text editor, you can select "Insert template" to import the contents of the text editor from an existing Experiment template. This allows you to combine content from multiple templates. -Using markdown -"""""""""""""" +Using Markdown +^^^^^^^^^^^^^^ .. image:: img/markdown-editor.* :alt: Markdown editor -You can also use markdown for the main text. Switch editor by clicking the Switch editor button at the bottom right of the main text edition zone. If you'd like the editor to become default, go to your Settings and enable "Disable the rich text editor and write Markdown directly". +You can also use Markdown to create the main text. You can switch to Markdown by clicking the "Switch editor" button at the bottom right of the main text box. If you'd like Markdown to be the default option, go to Settings and select "Disable the rich text editor and write Markdown directly". Tables -"""""" -If you add tables you might want to sort the data in the table dynamically. eLabFTW got you covered. Sort icons will be displayed in view mode when so called header cells (````) are defined and a table is set sortable. The table should have column names in the top row. You can select the top row with the mouse by clicking the left mouse button on the leftmost cell and while keeping the mouse button pressed move the mouse to the rightmost cell. Release the mouse button. The top row should be highlighted now. Next, from the rich text editor menu select «Table» → «Cell» → «Cell properties». In the dialog change «Cell type» from «Cell» (````) to «Header cell» (````). Finally, you can activate the sorting by clicking the «sortable table» icon (|sortable-table-icon|) in the tool bar. The icon will also indicate whether a selected table is sortable. After you saved the changes you can go to view mode and dynamically sort the table. The changed order is not stored in eLabFTW. Merged cells in the top/header row (colspan) and in columns (rowspan) are not supported. +^^^^^^ +If you add tables to the text editor you might want to dynamically sort the contained data. Don't worry, eLabFTW has you covered. Sort icons are displayed in "view" mode when "header cells" (````) are defined and a table is set as sortable. The table should have column names in the top row. You can select the top row by clicking the left mouse button with the cursor over the leftmost cell, and while keeping the mouse button pressed, move the cursor to the rightmost cell. Release the mouse button. The top row should be highlighted now. Next, from the text editor menu select «Table» → «Cell» → «Cell properties». In the dialog change the «Cell type» from «Cell» (````) to «Header cell» (````). Finally, you can activate sorting by clicking the «sortable table» icon (|sortable-table-icon|) in the tool bar. The icon will also indicate whether a selected table is sortable. After you have saved the changes (see "Saving your changes), you can go to "view" mode and dynamically sort the table. The changed order is not stored in eLabFTW. Merged cells in the top/header row (colspan) and in columns (rowspan) are not supported. .. |sortable-table-icon| image:: img/sortable-table-icon.png :align: middle @@ -182,11 +227,11 @@ If you add tables you might want to sort the data in the table dynamically. eLab :alt: Sort table demo Using LaTeX -""""""""""" +^^^^^^^^^^^ -It is possible to express mathematical/chemical notations in eLabFTW, and they will be rendered properly in view mode but also in the pdf export. +It is possible to express mathematical/chemical notation in eLabFTW, and formulas are rendered in both "view" mode and pdf exports. -For this eLabFTW uses Mathjax with ams extension. +To do this, eLabFTW uses Mathjax with the ams extension. Try this (make sure it is not pasted between `
` Tags!):
 
@@ -197,127 +242,54 @@ Try this (make sure it is not pasted between `
` Tags!):
 Use one `$` for inline mode and `$$` for block mode.
 
 Miscellaneous
-"""""""""""""
+^^^^^^^^^^^^^
+
+You can use basic text editor shortcuts and code snippets in the text editor to add highlighting, special characters, horizontal lines, etc...
+
+For a list of text shortcuts see this link: ``_
 
-You can insert a timestamp by clicking the clock icon or "Ctrl-Shift-d". You can also insert code snippets with highlighting, special characters, horizontal lines, etc...
+Examples:
 
+    - ctrl+shift+d : add date/time at cursor
+    - ctrl+= : subscript
+    - ctrl+shift+= : superscript
 
 Steps
-^^^^^
-Steps are a way to list the things one need to do during the Experiment. So you can write several steps, and once they are done, click the checkbox to declare them finished. This is quite useful for long Experiments spanning over several days, where the "Next step" will be shown in Show mode (index list), so you can see at one glance what is the next thing to do for this particular Experiment.
+-----
+You can use steps to list actions that need to be taken in connection with a given Experiment or Resource. When a task has been completed, you can click on the corresponding checkbox to indicate that that step is done. The "Next step" for each Experiment or Resource will be shown on the main Experiments or Resources page (index list) under the title for that entry. This lets you easily view the next step for each entry. You can also view the next steps for your Experiments and Resources by clicking on the "To-Do List" icon at the top left side of the main page.
 
-Note that you can also declare steps in a template.
+You can also include steps when making a template.
 
-Linked items
-^^^^^^^^^^^^
-This field allows you to link an item from the database. Just begin to type the name of what you want to link and you will see an autocompletion list appear. Select the one you want and press Enter. The number of links is not limited.
+Linked Resources/Experiments 
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+You can link a Resource or Experiment entry to another Experiment or Resource entry. Just begin to type the name of the entry you want to link in the text editor, Linked Resources field, or Linked Experiments field, and an autocompletion list will appear. Select the entry you want to link and press enter. If you link an entry from the text editor, it will automatically be added to the Linked Experiments/Resources section. The number of links is unlimited.
 
-This feature can also be used to link an Experiment to a particular Project. If you have a «Project» Item Type and have a Project item in your database, you will then be able to see all Experiments linked to this project by clicking the Link icon.
+This feature can be used to view the Resources or Experiments that are linked to a given entry. For example, you can view all the Experiments that use a particular Resource by looking at the Linked Experiments section in the entry for that Resource.
 
-Linked Experiments
-^^^^^^^^^^^^^^^^^^
-Same as above, but for Experiments.
+You can also use this feature to organize entries by project, sort of like a folder. For example, you can create a Resource entry for a given project and link all the Experiments and Resources that are associated with that project.
 
 Attach a file
-^^^^^^^^^^^^^
+-------------
 .. image:: img/user-file-uploader.png
     :align: center
     :alt: file uploader
 
-You can click this region to open a file browser, or drag-and-drop a file inside. The file size limit depends on the server configuration, but there is no limit on file type. If you upload an image, a thumbnail will be created. There is no limit on the number of files you can attach to an Experiment.
+Click this region to open the file browser, or drag and drop a file to this region to add it to the entry. The file size limit depends on the server configuration, but there is no limit on file type. If you upload an image, a thumbnail will be created. There is no limit on the number of files you can attach to an Experiment.
 
-Some files are recognized by eLabFTW:
+Various file types are recognized by eLabFTW:
 
-* molecules files such as cif, pdb, sdf, mol files, they will display the molecule in 2D or 3D
-* DNA files such as fasta, gb, ape, dna, gff, they will display a fully featured viewer
-* images such as png, jpg, gif or tiff will get a thumbnail
-* pdf files also get a thumbnail and can optionally be included in pdf exports
+* molecule files such as cif, pdb, sdf, and mol files: The resulting icon will display the molecule in 2D or 3D
+* DNA files such as FASTA, gb, ape, dna, and gff: These will be displayed via a fully featured viewer
+* image files such as png, jpg, gif, and tiff: These will show as a thumbnail icon
+* pdf files: These are shown as thumbnail icons and can optionally be included in pdf exports
 
 
-Ellipsis menu (the three dots on the top right)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The Switch Editor entry will switch from the WYSIWYG editor (TinyMCE) to the markdown editor. And the Delete entry is to remove the Experiment.
-
----------------
-
-When you are done, click the «Save and go back» button.
-
-You are now in view mode.
-
-
-View mode of Experiment
------------------------
-In the view mode, you will find an actions button bar in the upper left part:
-
-
-.. image:: img/user-view-toolbar.png
-    :align: center
-    :alt: view mode numbered
-
-1. Go back
-^^^^^^^^^^
-Go back to the listing.
-
-1. Edit
-^^^^^^^
-Switch to edit mode.
-
-1. Duplicate
-^^^^^^^^^^^^
-Duplicating an Experiment allows you to quickly create a new entry with the same Title, Tags, body, and links, but with today's date and a running Status. Uploaded files are not duplicated. An «I» character will be added to the title to denote that it is a replicate.
-
-1. Timestamp
-^^^^^^^^^^^^
-When you click this button, a timestamp archive is created. Timestamping an entry involves generating a full JSON export of the entry and creating a cryptographic hash of that data. This hash is then sent to a trusted third party: the TimeStamping Authority (TSA).
-
-The TSA acknowledges the existence of the data and sends back a signed token, which serves as proof that the data existed at that specific time. This process follows the :rfc:`3161` standard for Trusted Timestamping.
-
-The timestamped data and its token are then saved in the "Attached Files" section of the Experiment as a zip file. This file is initially in an "Archived" state, meaning it is hidden from view by default. To view archived files, click the "Show Archived" button on the right side of the "Uploaded Files" section in edit mode:
-
-.. image:: img/show-archived-uploads.png
-    :align: center
-    :alt: timestamp archive
-
-This timestamp archive is immutable and cannot be modified or deleted.
-
-.. image:: img/timestamp-archive.png
-    :align: center
-    :alt: timestamp archive
-
-
-5. Blockchain timestamp
-^^^^^^^^^^^^^^^^^^^^^^^
-This button, representing blocks, will do the same timestamping as above, except it will use the blockchain technology and the service provided by the BloxBerg consortium. You can learn more about it here: `BloxBerg website `_.
-
-6. Export button
-^^^^^^^^^^^^^^^^
-
-.. image:: img/view-mode-export-dropdown.png
-    :align: center
-    :alt: view mode export dropdown
-
-The Export menu allows you to save the entry in different formats. The term "Long term storage" refers to the PDF or the PDF contained in the zip archive being of a particular kind: PDF/A, an ISO-standardized version of the PDF format. It is a PDF format designed for long term storage, but transparent PNG will appear with a black background, so they are no longer the default PDF format, but an option. The PDF/A will also include the changelog, unlike the normal PDF export. It is the PDF format used for timestamping.
-
-The ELN format is a new file format based on RO-Crate specification, containing a special file (in JSON-LD) describing the contents of the dataset (one or several Experiments). It is a format designed and promoted by The ELN Consortium, an association of several ELN vendors that agreed on an interchange format for export/import of datasets. You can learn more about it here: `TheELNConsortium on GitHub `_.
-
-
-7. Toggle pin
-^^^^^^^^^^^^^
-Clicking this icon will make this entry appear on top of the listing (pin entry).
-
-8. Toggle lock
-^^^^^^^^^^^^^^
-The lock icon allows you to lock the entry to prevent further editing. If you lock it yourself, you can later unlock it, but if it is locked by an admin, a User won't be able to unlock it.
-
-9. Ellipsis menu
-^^^^^^^^^^^^^^^^
+Saving your changes
+-------------------
 
-.. raw:: html
+To save changes made to the text editor, click the floppy disk icon on the top left of the editor, or the Save button below it. Changes in the text editor are saved automatically 7 seconds after the user stopped typing.
 
-    Three dots speak volumes,

-    Unveiling hidden options,

-    Ellipsis unfolds.



+Changes made to any other field are saved automatically, or saved when you click outside of the field. A successful save action is indicated by the "Saved" banner that will show at the top left of the screen.
 
 
 elabid
@@ -326,7 +298,7 @@ In the bottom right part of the Experiment, you can see something like: «Unique
 
 Comments
 --------
-People can leave comments on Experiments. They cannot edit your Experiment, but they can leave a comment. The owner of the Experiment will receive an email if someone comment their Experiment.
+People can leave comments on Experiments. Not everyone can edit your Experiment, but they can leave a comment. The owner of the Experiment will receive an email if someone comment their Experiment.
 
 Templates
 =========
@@ -351,6 +323,8 @@ Resources
 =========
 Resources are similar to Experiments, but serve a different purpose: listing and organizing *things* that are used in Experiments.
 
+Many of the options on the Resource entry are the same as those for an Experiment entry.
+
 Only a team Admin can define the Resources Categories from the Admin Panel. Resources Categories could be:
 
 * Antibodies
@@ -449,7 +423,7 @@ Account tab
 This page allows you to modify your email/password, activate multi-factor authentication and change your name or add your `ORCID `_ if you have one.
 
 What is two factor authentication?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+----------------------------------
 Multi-factor authentication, MFA (or Two-factor authentication, 2FA) is a mechanism to further protect your account. After logging in with your password, you will need to enter a 6 digits code that changes every 30 seconds. This code will be displayed by a special application on your cellphone. If you have never used such a mechanism, you need to first install a 2FA application on your phone.
 
 * For Android phones, the recommended application is `Aegis `_ (Open Source).
@@ -469,8 +443,8 @@ Api keys tab
 ------------
 Create an API key for your account from this page. An API key is like a Username+password for your account. It allows you to interact with eLabFTW programmatically, through the REST API. See :ref:`API documentation `.
 
-How to have folders or projects grouping Experiments?
-=====================================================
+How to group Experiments into Projects?
+=======================================
 
 There are several options:
 
@@ -534,6 +508,11 @@ Using Categories
 ----------------
 An Admin can define several Experiments Categories, which are then available to Users in the Team. It is a quick and easy way to group Experiments together.
 
+To-Do List
+----------
+
+From the main Experiments or Resources pages, press ``t`` to show your "To-Do List". You can also access the "To-Do List" by clicking on the icon at the top left side of the screen.
+
 Miscellaneous
 =============
 
@@ -541,7 +520,6 @@ You can export Experiments in .zip. If the Experiment was timestamped you will f
 
 You can export and import items from the database (it can be several items).
 
-Press 't' to have a TODO list.
 
 .. raw:: html
 
@@ -655,11 +633,30 @@ In eLabFTW, changes are tracked with a different granularity depending on the in
 
 For an Experiment or Resource, there are two concepts: the Changelog, and the Revisions. The Revisions only tracks changes of the Main text (body) of the entry. The Changelog tracks all changes, except the content of the main text, as this is handled separately by the Revisions system.
 
-You can access the Changelog or the Revisions through the ellipsis menu (three dots) in the top right of the view or edit page of an entry. The Revisions also allows you to compare two versions or restore a particular version.
+You can access the Changelog or the Revisions through the ellipsis menu (three dots) in the top right of the page for an entry. The Revisions page allows you to compare two versions or restore a particular version of the entry.
+
+All administrative changes, such as creating a new User, promoting a User to Admin, assigning a User in a team, and changing an instance parameter are logged in the Audit logs database table, and visible to the Sysadmin from the Audit Logs tab in Sysconfig panel.
+
+.. _soft-delete:
+
+Soft delete mechanism
+=====================
+
+eLabFTW uses a soft-delete mechanism for entries. When you delete an experiment or a resource, it is simply marked as being deleted: its State changes from Normal to Deleted (another possible State would be Archived). This means the entry will still be accessible in the backend database as a deleted entity.
+
+Restoring a deleted entry
+-------------------------
+
+Currently, only a Sysadmin with MySQL access is able to restore an entry, by changing the State back to 1.
+
+Example MySQL query to restore an experiment with ID 42:
+
+.. code-block:: sql
+
+   UPDATE experiments SET state = 1 WHERE id = 42;
 
-All administratives changes such as creating a new User, promoting a User to Admin, assigning a User in a team, changing an instance parameter, are logged in the Audit logs database table, and visible to the Sysadmin from the Audit Logs tab in Sysconfig Panel.
+Values for ``state`` can be found in the `source code `_.
 
-When deleting something, the entry/file is not actually deleted but simply marked as being deleted. This prevents destructive actions and allows for easy restoration of accidentally deleted things. This mechanism is called "soft-delete".
 
 Sharing with external collaborators
 ===================================