Showing posts with label highlighting. Show all posts
Showing posts with label highlighting. Show all posts

Monday, June 19, 2017

PDFComment: Menyertakan Komentar pada Naskah

Mukadimah

Dunia penuh "warna", demikian ungkapan yang kerap kita dengar. Demikian pula kaitannya dengan isi tulisan atau naskah pada suatu dokumen. Untuk suatu maksud tertentu, layaklah bila kita mempertimbangkan cara dan teknis agar naskah/dokumen itu tampak "anggun", menarik, dan praktis. 
Perhatikan gambar di samping ini. Pada suatu ketika Anda mungkin pernah menemukan suatu dokumen berbentuk PDF yang memuat "penandaan" semacam itu dan berisi suatu komentar dari penulisnya. 
Bagaimana penulis/penyunting dokumen melakukan hal itu?
Di dalam $\LaTeX$ kita memiliki sumber daya semacam itu, yang dikemas dalam bentuk paket. Ada fixme, todonotes, cooltooltips, fancytooltips, dan pdfcomment. Kita akan mengulas yang disebut terakhir itu.

Teknis Penulisan

Lebih dulu, pada mukadimah, kita cantumkan paketnya.
\usepackage[opsi]{pdfcomment}
Ada beberapa opsi yang (mungkin) perlu dan dapat kita cantumkan. (Anda dapat mempelajarinya secara lengkap pada dokumentasinya.) Salah satunya adalah nama seseorang (penulis atau siapa pun) yang menyatakan komentar itu. Bila nama komentator itu ingin dicetak (disertakan) maka kita nyatakan
\usepackage[author={nama_komentator_yang_dirujuk}]{pdfcomment}
Sekarang kita dapat memulai untuk menerapkan komentar pada bagian dari naskah/tulisan. Komentar kita berikan dalam bentuk perintah beserta opsinya (sekiranya diperlukan). Ada beberapa perintah yang dapat kita gunakan (seperti tertuang pada dokumentasinya), namun saya hanya akan mengulasnya dua saja, yaitu pdfcomment dan pdfmarkupcomment. Masing-masingnya dapat kita letakkan pada awal, akhir, atau di antara keduanya pada suatu kalimat (teks). Perintah pertama kita nyatakan sebagai
\pdfcomment[opsi]{teks_komentar}
Ada beberapa opsi yang dapat kita pilih dan cantumkan, di antaranya warna dan ikon (lihat dokumentasinya). Untuk baris pertama pada contoh di atas, saya nyatakan
Persamaan kuadrat $ax^2+bx+c=0$, $a\neq0$, selalu \pdfcomment[color=red,icon=Note]{Perhatikan ini!} memiliki dua akar.
Berbagai jenis ikon dapat Anda lihat pada dokumentasinya.

Perintah kedua saya nyatakan sebagai
\pdfmarkupcomment[opsi]{teks_yang_dikenai_opsi}{teks_komentar}
Ada beberapa opsi yang dapat kita pilih dan cantumkan, di antaranya warna dan markup (lihat dokumentasinya). Untuk baris kedua pada contoh di atas, saya nyatakan
\pdfmarkupcomment[markup=StrikeOut,color=red]{Dilarang membuang}{Buanglah} pada tempatnya!
Opsi markup menyediakan $4$ pilihan, yaitu teks yang dilatari oleh suatu warna (Highlight), teks yang digarisbawahi (Underline), teks yang digarisbawahi oleh garis bergerigi (Squiggly), dan teks yang dicoret (StrikeOut).

Demikianlah untuk baris ketiga, keempat, dan kelima berturut-turut saya nyatakan
\pdfmarkupcomment[markup=StrikeOut,color=red]{Dilarang membuang}{Buanglah} pada tempatnya!

\pdfmarkupcomment[markup=Highlight,color=yellow]{Setiap waktu akan menuakan sesuatu.}{Ini hasil dari permenungan, hehehe ...}

Perhatikan gambar \pdfcomment[icon=Comment,color=blue]{Ingat gambarnya!} berikut ini!
Hasilnya terlihat pada dokumen berikut ini. Anda perlu menggunakan Adobe Reader atau Adobe Acrobat Reader DC untuk membuka dan menampakkan hasilnya. Kemudian penampakkannya itu dapat pula Anda atur pada menu Tools > Comment.






Penutup

Tak sesuai dengan lirik dari Andra and the BackBone, paket pdfcomment tidaklah begitu sempurna. "Kekurangannya" antara lain:
  • Penampakkan ikon komentar cukup menyita "ruang baris" untuk teks. Oleh karena itu (seperti contoh dokumen tersebut), penyertaan penggunaan paket pdfcomment akan tampak agak baik bila digunakan spasi (linespread) $2\textrm{pt}$.  
  • Terdapat kerenggangan yang cukup jauh antara teks komentar dengan tepi atas kotak komentar, ketika opsi global paket itu tidak menggunanakan nama komentator.
  • Teks komentar tidak dapat dinyatakan dalam modus matematis (rumus). 
  • Ikon komentar memberikan kesan "ramai" pada tulisan/naskah.
Untuk meniadakan kesan "ramai" itu, kita dapat menggunakan perintah pdftooltip melalui suatu perintah baru (cantumkan pada mukadimah). Misalnya,
\newcommand\komentar[3]{\newcommand{#1}{\pdftooltip{#2}{#3}}}
Sebagai contoh, kita dapat menggunakannya dalam menyatakan rumus untuk persamaan garis bergradien $m$ dan melalui suatu koordinat $(a,b)$. Untuk keperluan itu kita dapat menetapkan beberapa perintah yang mendukungnya, misalnya
\komentar{\m}{m}{gradien}
\komentar{\absis}{a}{absis dari titik yang dilalui oleh garis}
\komentar{\ordinat}{b}{ordinat dari titik yang dilalui oleh garis}
\komentar{\teks}{Persamaan garis}{sebagai contoh saja}
Dengan demikian di dalam naskah dapat kita tuliskan
\teks\ yang bergradien $m$ dan melalui koordinat $(a,b)$ ditentukan oleh $y-\ordinat = \m(x-\absis)$.
dan hasilnya tampak pada baris terakhir dalam dokumen terlampir berikut ini. Silakan Anda arahkan kursor pada bagian rumus $y-b=m(x-a)$, maka pada huruf-huruf $b$, $m$, dan $a$ Anda akan memperoleh komentar sebagaimana telah ditetapkan di atas.
Demikian semoga bermanfaat.

$\square$ Adjie Gumarang Pujakelana 2017



Sunday, June 26, 2016

Menampilkan Pengkodean dalam Dokumen LaTeX

Mukadimah

Untuk suatu keperluan tertentu, kita kadang ingin menunjukkan kepada pembaca tentang suatu pengkodean yang menghasilkan teks/gambar yang dihasilkan. Meskipun demikian, memang masih diperlukan keterangan tambahan secara terpisah tentang paket dll yang digunakan untuk itu, baik di dalam mukadimah (preamble) maupun di dalam badan dokumen (main body).
Bagaimana cara menunjukkan kepada pembaca tentang pengkodean untuk gambar di samping ini? Ada beberapa cara yang dapat dilakukan untuk itu, tetapi kali ini akan saya tunjukkan empat cara, yaitu dengan menggunakan
  1. lingkup perintah (environment) verbatim 
  2. paket listings 
  3. paket minted 
  4. paket showexpl 

Menampilkan Kode dengan Menggunakan Verbatim

Lingkup perintah verbatim telah disediakan oleh $\small\LaTeX$, oleh karena itu kita dapat langsung menggunakannya dengan menuliskan
\begin{verbatim} 
Tulis kode di sini 
\end{verbatim}
Dengan menggunakan lingkup perintah verbatim, kode untuk gambar tersebut dapat diperlihatkan oleh
\begin{verbatim}
\begin{tikzpicture}
\node (a) at (0,0) {$\tan x$};
\node (b) at (4,0) {$\sec^2 x$};
\draw[-latex,bend left,blau]  (a) edge (b) ;
\draw[-latex,bend left,Tomato]  (b) edge (a);
\path[blau] (a) -- (b) node[midway,above,yshift=.8cm] {\small diferensial};
\path[Tomato] (b) -- (a) node[midway,below,yshift=-.8cm] {\small integral};
\end{tikzpicture}
\end{verbatim}
Hasilnya seperti ini


Menampilkan Kode dengan Menggunakan Paket Listings

Seperti terlihat di atas, hasil dari lingkup perintah verbatim tampak ``biasa'' saja. Mungkin akan tampak lebih menarik bila, misalnya, kode itu diletakkan di dalam suatu bingkai (frame) dan dilatari oleh suatu warna. Kita dapat melakukan itu dengan menggunakan paket listings. Lebih dulu, dalam mukadimah kita muat paket listings beserta pengaturan dalam penggunaannya, misalnya
\usepackage{listings}
\lstset{
basicstyle=\ttfamily,frame=lines,
framexleftmargin=0.5em,framexrightmargin=0.5em,
backgroundcolor=\color{LemonChiffon}
}
kemudian kita menuliskan kodenya dan mengatur lebar bingkainya, misalnya
\begin{lstlisting}[linewidth=10cm]
Tulis kode di sini
\end{lstlisting}
Hasilnya seperti ini
Hal-hal lainnya sehubungan dengan penggunaan paket listings dapat dipelajari dalam dokumentasinya.


Menampilkan Kode dengan Menggunakan Paket Minted

Seperti telihat di atas, meskipun paket listing dapat menampilkan kode berbingkai disertai oleh pewarnaan pada latarnya tetapi teks yang dihasilkan berwarna dasar (hitam). Mungkin akan tampak lebih menarik bila digunakan warna berbeda pada teks tersebut. Inilah yang dilakukan oleh paket minted. Lebih dulu, dalam mukadimah kita muat \usepackage{minted} kemudian kita menuliskan kodenya, misalnya, sebagai berikut.
\begin{minted}[
    frame=lines,
    framerule=1pt,
    framesep=5pt,
    rulecolor=\color{bistre}
            ]{latex}
Tuliskan kode di sini
\end{minted}
Dengan menggunakan paket minted, kode untuk gambar tersebut dapat diperlihatkan oleh
\begin{minted}[
    frame=lines,
    framerule=1pt,
    framesep=5pt,
    rulecolor=\color{bistre}
            ]{latex}
\begin{tikzpicture}
\node (a) at (0,0) {$\tan x$};
\node (b) at (4,0) {$\sec^2 x$};
\draw[-latex,bend left,blau]  (a) edge (b) ;
\draw[-latex,bend left,Tomato]  (b) edge (a);
\path[blau] (a) -- (b) node[midway,above,yshift=.8cm] {\small diferensial};
\path[Tomato] (b) -- (a) node[midway,below,yshift=-.8cm] {\small integral};
\end{tikzpicture}
\end{minted}
Hasilnya seperti ini
Hal-hal lainnya sehubungan dengan penggunaan paket minted dapat dipelajari dalam dokumentasinya.


Menampilkan Kode dengan Menggunakan Showexpl

Sesuai dengan namanya, kelebihan dari paket showexpl adalah dapat menunjukkan gambar yang dibuat sekaligus dengan menunjukkan kodenya, disertai dengan penomoran pada tiap barisnya. Pada opsinya, kita juga dapat memberinya garis bingkai dan warna pada latarnya, sedangkan teks hanya dalam satu warna. Lebih dulu, dalam mukadimah kita muat paket showexpl beserta pengaturan dalam penggunaannya, misalnya 
\usepackage{showexpl}
\lstdefinestyle{gayaku}{
    backgroundcolor=\color{BurlyWood!15},
    numberstyle=\footnotesize, 
    numbersep=5pt,
    rframe=
}
kemudian kita menuliskan kodenya dan mengatur lebar bingkainya, misalnya
\begin{LTXexample}[style=gayaku,width=.3\linewidth,pos=l]
Tuliskan kode di sini
\end{LTXexample}
Opsi tersebut memerintahkan $\small\LaTeX$ untuk menggunakan pengaturan ``gayaku'' yang telah ditetapkan dalam mukadimah, ``kolom'' halaman terbagi atas 30% untuk gambar dan 70% untuk kodenya, kemudian gambar diletakkan di kiri (l = left). Perhatikan contoh penggunaannya berikut ini.
\begin{LTXexample}[style=gayaku,width=.3\linewidth,pos=l]
\begin{tikzpicture}
\node (a) at (0,0) {$\tan x$};
\node (b) at (4,0) {$\sec^2 x$};
\draw[-latex,bend left,blau]  (a) edge (b) ;
\draw[-latex,bend left,Tomato]  (b) edge (a);
\path[blau] (a) -- (b) 
node[midway,above,yshift=.8cm] {\small diferensial};
\path[Tomato] (b) -- (a) 
node[midway,below,yshift=-.8cm] {\small integral};
\end{tikzpicture}
\end{LTXexample}
Hasilnya seperti ini

Penutup

Demikianlah sesuai dengan keperluannya kita menunjukkan kode atas hasil gambar (atau teks) yang kita buat dengan menggunakan salah satu dari keempat pilihan tersebut.
Semoga tulisan ini bermanfaat.

$\square$ Adjie Gumarang Pujakelana 2016

Friday, May 29, 2015

Menyoroti (Highlighting) Teks

Tanpa bermaksud turut mempromosikannya, saya (terpaksa) akan menyebut nama produk. Ingat Stabilo, bukan?
Ini mengingatkan saya pada masa bersekolah dulu. Ketika saya membaca (buku catatan atau buku bacaan), sering kali saya gunakan alat itu untuk menggoresi bagian teks yang saya anggap penting agar tampak "warna pencerah" yang menandainya. Mungkin ini semacam mnemonik, yang dapat membantu saya dalam memahami atau menghafal materi yang saya baca. 
Apa kaitan ini dengan $\small\LaTeX$?

Tanpa menggunakan alat tersebut, kita dapat melakukan hal yang sama, bahkan jauh sebelum tulisan kita itu dicetak. Penampakkannya persis seperti goresan tangan (handwriting). Bahkan, bila perlu, kita dapat memunculkan "garis pinggir" (suatu hal yang tidak dapat dilakukan oleh alat itu) dari goresan itu dengan beragam warna pilihan yang kita kehendaki. Nah, agar lebih nyata, silakan perhatikan contoh dokumen berikut ini.




Bagaimana bila yang disorot itu dalam modus matematis? Masih bisa, hanya saja secara inline (tidak cocok untuk cara display). Lalu, bagaimana hal itu dilakukan?
Ini hasil kerja seorang "ahli" (expert), yang meramu dua paket: soul (sebagai dasar) dan tikz.

Secara baku, sebenarnya kita cukup menyediakan dua paket
\usepackage{color}
\usepackage{soul}
kemudian kita gunakan perintah \hl{...}, misalnya
\hl{``NU, Muhammadiyah, dan semacamnya itu \emph{wasilah} atau \emph{ghoyyah}?''}
dengan goresan warna latar dasar, yaitu kuning.

Jika diinginkan, kita pun dapat memanfaatkan paket xcolor (dengan opsi, misalnya, svgnames) untuk penggunaan warna latar lainnya, dengan memberikan perintah baru di dalam preamble, misalnya
\newcommand{\hlc}[2][yellow]{ {\sethlcolor{#1} \hl{#2}} }
kemudian kita gunakan
\hlc[Salmon]{``NU, Muhammadiyah, dan semacamnya itu \emph{wasilah} atau \emph{ghoyyah}?''}

Berbeda dengan itu, seorang anggota forum, dengan nama pengguna Antal S-Z, menunjukkan lekukan (wiggly) secara "alami" dan tampak terpisah pada hasil penggoresan dalam dua baris (perhatikan bagian bawah dalam contoh dokumen di atas).
Paket dan makro yang dibuatnya adalah sebagai berikut.
\usepackage{soul}
\usepackage{tikz}
\usetikzlibrary{calc}
\usetikzlibrary{decorations.pathmorphing}

\makeatletter

\newcommand{\defhighlighter}[3][]{%
  \tikzset{every highlighter/.style={color=#2, fill opacity=#3, #1}}%
}

\defhighlighter{yellow}{.5}

\newcommand{\highlight@DoHighlight}{
  \fill [ decoration = {random steps, amplitude=1pt, segment length=15pt}
        , outer sep = -15pt, inner sep = 0pt, decorate
        , every highlighter, this highlighter ]
        ($(begin highlight)+(0,8pt)$) rectangle ($(end highlight)+(0,-3pt)$) ;
}

\newcommand{\highlight@BeginHighlight}{
  \coordinate (begin highlight) at (0,0) ;
}

\newcommand{\highlight@EndHighlight}{
  \coordinate (end highlight) at (0,0) ;
}

\newdimen\highlight@previous
\newdimen\highlight@current

\DeclareRobustCommand*\highlight[1][]{%
  \tikzset{this highlighter/.style={#1}}%
  \SOUL@setup
  %
  \def\SOUL@preamble{%
    \begin{tikzpicture}[overlay, remember picture]
      \highlight@BeginHighlight
      \highlight@EndHighlight
    \end{tikzpicture}%
  }%
  %
  \def\SOUL@postamble{%
    \begin{tikzpicture}[overlay, remember picture]
      \highlight@EndHighlight
      \highlight@DoHighlight
    \end{tikzpicture}%
  }%
  %
  \def\SOUL@everyhyphen{%
    \discretionary{%
      \SOUL@setkern\SOUL@hyphkern
      \SOUL@sethyphenchar
      \tikz[overlay, remember picture] \highlight@EndHighlight ;%
    }{%
    }{%
      \SOUL@setkern\SOUL@charkern
    }%
  }%
  %
  \def\SOUL@everyexhyphen##1{%
    \SOUL@setkern\SOUL@hyphkern
    \hbox{##1}%
    \discretionary{%
      \tikz[overlay, remember picture] \highlight@EndHighlight ;%
    }{%
    }{%
      \SOUL@setkern\SOUL@charkern
    }%
  }%
  %
  \def\SOUL@everysyllable{%
    \begin{tikzpicture}[overlay, remember picture]
      \path let \p0 = (begin highlight), \p1 = (0,0) in \pgfextra
        \global\highlight@previous=\y0
        \global\highlight@current =\y1
      \endpgfextra (0,0) ;
      \ifdim\highlight@current < \highlight@previous
        \highlight@DoHighlight
        \highlight@BeginHighlight
      \fi
    \end{tikzpicture}%
    \the\SOUL@syllable
    \tikz[overlay, remember picture] \highlight@EndHighlight ;%
  }%
  \SOUL@
}
\makeatother
Kemudian saya gunakan (untuk bagian teks yang saya goresi), dengan menambahkan paket xcolor dalam opsi svgnames untuk pemilihan warna, sebagai berikut.
\highlight[Salmon]{Ahmad Mustofa Bisri} \\
\highlight{``PPP, PDI, dan Golkar itu \emph{wasilah} atau {\em ghoyyah}?''} \\ 
\highlight{``NU, Muhammadiyah, dan semacamnya itu \emph{wasilah} atau \emph{ghoyyah}?''} \\
\highlight[draw=Dandelion]{``Islam, Katholik, Hindu, dan semacamnya itu \emph{wasilah} atau {\em ghoyyah} (tujuan)?''}\\ 
\highlight[SeaGreen, draw=CadetBlue]{\emph{Ghoyyah} itu artinya tujuan akhir. \emph{Wasilah} itu artinya sarana menuju.}\\
\highlight[Salmon, draw=IndianRed]{``Agama Islam adalah \emph{wasilah}.''} \\
\highlight[Salmon]{``Karena \emph{ghoyyah}-nya (tujuannya) adalah Allah.''} \\
\highlight[SeaGreen]{awal mula kesalahan beragama adalah menganggap agama Islam seperti partai politik. Ditambah salah menetapkan apa yang menjadi \emph{wasilah} dan apa yang menjadi \emph{ghoyyah} dalam agama Islam.}
Opsi draw kita nyatakan bila ingin menampakkan "garis pinggir pada lekukan goresan itu.

Demikian semoga bermanfaat. Dokumen di atas saya susun (compile) dalam jaringan melalui Online LaTeX Editor ShareLaTeX.

Adjie Gumarang Pujakelana 2015

Sunday, March 22, 2015

Minted

Ketika saya menulis atau menggambar sesuatu, saya ingin pembaca dokumen yang saya susun itu dapat melakukan hal yang sama dengan mengikuti pengkodean yang saya tunjukkan. Secara umum, saya dapat melakukannya dengan menggunakan environment verbatim atau (untuk yang ringkas) saya nyatakan dalam \verb!...! atau dalam {\ttfamily ...}. Bagaimana kalau sintaks pengkodean itu saya soroti (highlighting) dengan "taburan" warna, seperti tampak pada gambar di samping?

Inilah hal baru (bagi saya) yang saya peroleh ketika sedang bekerja dalam menerjemahkan dokumentasi paket tkz-euclide, sebuah paket dari Alain Matthes yang merupakan alat untuk menggambar Geometri Euclides. Perhatikan contoh berikut ini.
Anda, pembaca, yang sedang membaca dokumen yang memuat gambar tersebut mungkin bertanya, "Bagaimana cara membuat gambar itu?". Nah, agar pembaca mengetahui pengkodeannya, saya tunjukkan
Lalu, bagaimana caranya untuk menunjukkan itu?
Tentu berbeda dengan menunjukkan berbagai pengkodean yang telah saya lakukan dalam blog ini. Karena ini dimaksudkan agar tampak dalam dokumen yang disusun, maka di sinilah saya memerlukan paket minted. Paket minted berguna untuk menyoroti (highlighting) kode sumber dalam $\small\LaTeX$, yang memudahkan penyorotan sintaks secara tepat dan jelas berkat digunakannya library Pygments yang kuat. Paket ini juga menyediakan pilihan untuk menyesuaikan penampakkan kode sumber yang disorot dengan menerapkan paket fancyvrb.

Untuk menunjukkan sintaks pengkodean tersebut, dalam preamble saya muat
\usepackage{minted}
\usepackage{tcolorbox}
\usepackage{etoolbox}
\BeforeBeginEnvironment{minted}{\begin{tcolorbox}}%
\AfterEndEnvironment{minted}{\end{tcolorbox}}%
Paket tcolorbox dan etoolbox beserta pengaturan environment-nya disiapkan untuk pengkotakkannya. Dalam penggunaannya, environment tersebut dinyatakan dengan
\begin{minted}{latex}
...
\end{minted}
Untuk menampakkan pengkodean seperti ditunjukkan oleh gambar pertama, yang mengawali tulisan ini, saya muat
\usepackage{minted}
\definecolor{bistre}{RGB}{133, 109, 77}
dalam preamble dan dalam penggunaan environment-nya dinyatakan
\begin{minted}[frame=lines,framerule=1pt,framesep=5pt,rulecolor=\color{bistre}]{latex}
...
\end{minted}
Demikianlah contoh-contoh pembuatan gambar di atas saya susun melalui Online LaTeX Editor ShareLaTeX. 
Demikian semoga bermanfaat.

Adjie Gumarang Pujakelana 2015 


Related Posts Plugin for WordPress, Blogger...