Code Cite - VS Code Extension

English Version | Versi Bahasa Indonesia

English Version

Code Cite is a Visual Studio Code extension designed to help academics, students, and developers track and cite code blocks directly within their editor. It streamlines the process of integrating code references (e.g., from StackOverflow, documentation, or AI models) and exporting them into a format compatible with the Code Cite web application.

Academic Information

• Developer: Kevin Owen
• Supervisor: Oscar Karnalim, S.T., M.T., Ph.D.
• Department: Informatics Engineering
• Faculty: Smart Technology and Engineering
• University: Maranatha Christian University

Key Features

1. Add Citation Block: Automatically inserts a citation comment template above the selected code block.
2. Smart Parsing: Supports both multi-line and single-line citation formats.
3. Workspace Export: Scans the entire workspace, extracts citations, and packages the project into a .zip file containing a .codesite.json metadata file.

How to Use

1. Select Code: Highlight the lines of code you want to cite.
2. Add Citation: Right-click and select Code Cite: Add Citation or use the Command Palette (Ctrl+Shift+P).
3. Fill Metadata: Update the generated template:
   • Title: Title of the reference.
   • Type: url, ai, or other.
   • Value: Link or specific source identifier.
   • Lines Range: Automatically calculated, but can be manually adjusted.
4. Export: Run Code Cite: Export Citations from the Command Palette to generate the .zip package.

Supported Formats

The parser recognizes two types of comments in Python (#) and Java (//):

1. Multi-line Format:

# CODE-CITE:
#   Title: My Reference
#   Type: url
#   Value: [https://example.com](https://example.com)
#   Lines Range: 5

2. Single-line Format:

# CODE-CITE #Title #Type #Value #Notes #LinesRange

Versi Bahasa Indonesia

Code Cite adalah ekstensi Visual Studio Code yang dirancang untuk membantu akademisi, mahasiswa, dan pengembang melacak dan menyitasi blok kode langsung di dalam editor. Ekstensi ini mempermudah proses integrasi referensi kode (misalnya dari StackOverflow, dokumentasi, atau model AI) dan mengekspornya ke format yang kompatibel dengan aplikasi web Code Cite.

Informasi Akademik

• Pengembang: Kevin Owen
• Pembimbing: Oscar Karnalim, S.T., M.T., Ph.D.
• Program Studi: Teknik Informatika
• Fakultas: Fakultas Teknologi dan Rekayasa Cerdas
• Universitas: Universitas Kristen Maranatha

Fitur Utama

1. Tambah Blok Sitasi: Menyisipkan template komentar sitasi secara otomatis di atas blok kode yang dipilih.
2. Parsing Cerdas: Mendukung format sitasi multi-baris maupun satu baris ( single-line ).
3. Ekspor Workspace: Memindai seluruh workspace, mengekstrak sitasi, dan mengemas proyek ke dalam file .zip yang berisi metadata .codesite.json.

Cara Penggunaan

1. Pilih Kode: Sorot baris kode yang ingin Anda sitasi.
2. Tambah Sitasi: Klik kanan dan pilih Code Cite: Add Citation atau gunakan Command Palette (Ctrl+Shift+P).
3. Isi Metadata: Perbarui template yang muncul:
   • Title: Judul referensi.
   • Type: url, ai, atau other.
   • Value: Tautan atau pengidentifikasi sumber.
   • Lines Range: Terisi otomatis berdasarkan jumlah baris yang dipilih.
4. Ekspor: Jalankan perintah Code Cite: Export Citations untuk menghasilkan file .zip.

Format yang Didukung

Parser mengenali dua jenis komentar pada Python (#) dan Java (//):

1. Format Multi-baris:

# CODE-CITE:
#   Title: Referensi Saya
#   Type: url
#   Value: [https://example.com](https://example.com)
#   Lines Range: 5

2. Format Satu Baris (Single-line):

# CODE-CITE #Judul #Tipe #Value #Catatan #LinesRange