PS_ADD_BOOKMARK(3)

📦 version 0.4.8, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

✨ PS_ADD_BOOKMARK(3) ✨

Library Functions Manual 🎀 bestie we're in the library functions section today, section 3, C-coded and cunty

💖 NAME 💖

PS_add_bookmark — add a bookmark to the current page 📖✨

🦋 SYNOPSIS 🦋

#include <pslib.h>

int PS_add_bookmark(PSDoc *psdoc, const char *text, int parent, int open)

look at that signature. five things. count them. slay. 💅

🌸 DESCRIPTION 🌸

Okay so here's the tea ☕: PS_add_bookmark drops a bookmark onto the current page. That's it, that's the job.

In PDF viewers, bookmarks usually chill on the left side of the page in a hierachical tree 🌳 (yes, hierarchical, the manpage said it like that, I'm not fixing it, it's part of the vibe). And when you click one? Boom 💥 you jump straight to the page it points at. Main character navigation energy.

🎀 the parameters, bestie

  • parent — this is another bookmark, and it becomes the parent of your brand new bookmark. It's giving family tree 🫶.
  • open — if this is unequal to zero, the PDF viewer will show that bookmark open. If it's zero, it stays closed. Simple as.
🚨 IMPORTANT VIBE CHECK 🚨 the bookmark has no meaning if the document is just printed or viewed. It only does anything when the document gets converted to pdf by either Acrobat Distiller™ or Ghostview. So don't come crying to me when your printer doesn't care about your cute little tree 😭.

⭐ the return value tho

The returned value is a reference for the bookmark. And like… it only matters if you're gonna use that bookmark as a parent later. That's its whole purpose. It's the bookmark's nepo-baby moment 👑.

🌈 RETURN VALUE 🌈

Returns the identifier of the bookmark, or zero if something went wrong 💀.

The identifier is a positiv number. (Positive. Again: manpage's spelling, not mine. We keep receipts around here fr fr.)

🫶 so like, zero = error, anything else = you got an ID and you ate.

👑 SEE ALSO 👑

the whole linky friend group. go say hi. they're all iconic. iykyk 💜

💜 AUTHOR 💜

This manual page was written by Uwe Steinmann uwe@steinmann.cx. 🫡 thank you for your service, legend.

and that's a wrap on PS_ADD_BOOKMARK(3) from the Library Functions Manual — footer said the same thing twice and honestly? relatable. go forth, add bookmarks, be the tree you wish to see in the world 🦋💖✨

📦 where this page comes from