docs: python bindings howto

* Added metadata, author info, version number and xml:lang data.
This commit is contained in:
Ben McGinnes 2018-05-15 13:50:14 +10:00
parent f0063afa71
commit f64d259e1d
48 changed files with 83 additions and 47 deletions

View File

@ -1,9 +1,31 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE bookmap PUBLIC "-//OASIS//DTD DITA BookMap//EN" "bookmap.dtd">
<bookmap>
<bookmap xml:lang="en-GB">
<booktitle>
<mainbooktitle>GPGME Python Bindings HOWTO</mainbooktitle>
</booktitle>
<bookmeta>
<author>Ben McGinnes</author>
<authorinformation>
<personinfo>
<namedetails>
<personname id="author" name="Ben McGinnes"/>
</namedetails>
<emailaddresses id="author-email" name="ben@gnupg.org"/>
</personinfo>
<organizationinfo>
<emailaddresses>
<emailaddress id="gnupg-devel" name="gnupg-devel@gnupg.org"/>
</emailaddresses>
<urls>
<url id="web" name="https://gnupg.org"/>
</urls>
</organizationinfo>
</authorinformation>
</bookmeta>
<frontmatter>
<draftintro id="draft" href="howto/version-info.dita"/>
</frontmatter>
<part id="part-1" href="howto/part-1.dita">
<topicref id="intro" href="howto/part01/introduction.dita">
<topicref id="py2v3" href="howto/part01/python2-vs-python3.dita"/>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_syw_3qx_5db">
<title>Introducing the Python Bindings</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_y52_zwx_5db">
<title>Preparation and Setting Up</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_s5w_23y_5db">
<title>Working With Keys</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_dz3_mpy_5db">
<title>The Fun Stuff</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_akd_rwz_5db">
<title>Generating Keys</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_bdk_vwz_5db">
<title>Miscellaneous Work-arounds</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_nb3_hrx_5db">
<title>Documentation Source Files</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_bv2_qqx_5db">
<title>Examples</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_ucm_3mx_5db">
<title>Introduction</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_j1r_qmx_5db">
<title>Python 2 vs. Python 3</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_jrb_pxx_5db">
<title>A C API</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_bpb_why_5db">
<title>Context</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_ob2_yzx_5db">
<title>The gnupg package created and maintained by Isis Lovecruft</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_ecj_yyx_5db">
<title>Difference between the Python bindings and other GnuPG Python packages</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_xsp_ygy_5db">
<title>Fundamentals</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_zm1_lxx_5db">
<title>GPGME Concepts</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_isl_32y_5db">
<title>GPGME Python bindings installation</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_ivh_zfy_5db">
<title>Installing</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_mss_p2y_5db">
<title>No PyPI</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_wmg_2hy_5db">
<title>No REST</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_oy4_zcy_5db">
<title>The PyME package maintained by Martin Albrecht</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_g4z_wxx_5db">
<title>Python Bindings</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_llw_kzx_5db">
<title>The python-gnupg package maintained by Vinay Sajip</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_zqn_nfy_5db">
<title>Requirements</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_j3h_5my_5db">
<title>Get Key</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_jgw_wly_5db">
<title>Counting Keys</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_flg_p3y_5db">
<title>Key Selection</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_w5f_zpy_5db">
<title>Basic Functions</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_ydy_5qz_5db">
<title>Clear Signatures</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_vqx_tqy_5db">
<title>Decryption</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_ntx_sqz_5db">
<title>Default Signatures</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_rfg_5qz_5db">
<title>Detached Signatures</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_wmg_tjz_5db">
<title>Encrypting to Multiple Keys</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_dkk_sjz_5db">
<title>Encrypting to One Key</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_on2_nqy_5db">
<title>Encryption</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_dpb_fqz_5db">
<title>Signing Key Selection</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_nqk_vqy_5db">
<title>Signing Text and Files</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_p3g_yqy_5db">
<title>Signature Verification</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_e4q_jyz_5db">
<title>Adding a User ID</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_p15_1yz_5db">
<title>Key Certification</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_c4z_syd_vdb">
<title>Creating Keys and Subkeys</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_nfy_byz_5db">
<title>Primary Key Creation</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_fbb_lyz_5db">
<title>Revoking a User ID</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_cb4_fyz_5db">
<title>Subkey Creation</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_d1j_hyz_5db">
<title>User IDs</title>
<body>

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita>
<dita xml:lang="en-GB">
<topic id="topic_gbm_bxz_5db">
<title>Group Lines</title>
<body>

View File

@ -0,0 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<dita xml:lang="en-GB">
<topic id="topic_vnz_nn2_vdb">
<title>Documentation Version</title>
<body>
<p><b>Version:</b> 0.1.1</p>
<p><b>Author:</b> Ben McGinnes &lt;<xref href="mailto:ben@gnupg.org" format="html"
scope="external">ben@gnupg.org</xref>></p>
<p><b>Author GPG Key ID:</b> DB4724E6FA4286C92B4E55C4321E4E2373590E5D</p>
<p><b>Language:</b> Australian English, British English</p>
</body>
</topic>
</dita>