From bbd14d34cd90e8cb4734dd5cfd84df15233d7c4e Mon Sep 17 00:00:00 2001 From: Alex Roitman Date: Thu, 27 Oct 2005 04:14:53 +0000 Subject: [PATCH] * src/plugins/CmdRef.py (write_ref): Only write itemizedlist if there is any contents for it. * doc/gramps-manual/C/cmdplug.xml: Update to a valid docbook. * doc/gramps-manual/C/usage.xml: Add manual on the Narrative web page generator. svn: r5351 --- gramps2/ChangeLog | 7 + gramps2/doc/gramps-manual/C/cmdplug.xml | 458 ++++++++++++------------ gramps2/doc/gramps-manual/C/usage.xml | 218 +++++++++-- gramps2/src/plugins/CmdRef.py | 11 +- 4 files changed, 431 insertions(+), 263 deletions(-) diff --git a/gramps2/ChangeLog b/gramps2/ChangeLog index e98233d3c..7c6840ef4 100644 --- a/gramps2/ChangeLog +++ b/gramps2/ChangeLog @@ -1,3 +1,10 @@ +2005-10-26 Alex Roitman + * src/plugins/CmdRef.py (write_ref): Only write itemizedlist if + there is any contents for it. + * doc/gramps-manual/C/cmdplug.xml: Update to a valid docbook. + * doc/gramps-manual/C/usage.xml: Add manual on the Narrative web + page generator. + 2005-10-25 Don Allingham * src/latin_utf8.py: removed * src/Makefile.am: remove latin_utf8.py diff --git a/gramps2/doc/gramps-manual/C/cmdplug.xml b/gramps2/doc/gramps-manual/C/cmdplug.xml index 48aefb590..369ed7b63 100644 --- a/gramps2/doc/gramps-manual/C/cmdplug.xml +++ b/gramps2/doc/gramps-manual/C/cmdplug.xml @@ -106,8 +106,6 @@ id: =ID Gramps ID of a central person. MANDATORY - - @@ -194,25 +192,6 @@ - Book Report - - - name: - - book - - - - bookname: =name - - Name of the book. MANDATORY - - - - - - - Descendant Graph @@ -223,35 +202,7 @@ - - Descendant Wall Chart - - - name: - - descend_chart2 - - - - singlep: =0/1 - - Whether to scale to fit on a single page. - - Do not scale to fit - Scale to fit - - - - - title: =str - - Title string for the report - Value: Whatever String You Wish - - - - - + Descendant Report @@ -262,7 +213,7 @@ - + Detailed Ancestral Report @@ -281,16 +232,6 @@ - - listc: =0/1 - - Whether to list children. - - Do not list children - List children - - - incsources: =0/1 @@ -352,12 +293,12 @@ - firstnameiop: =0/1 + listc: =0/1 - Whether to use first names instead of pronouns + Whether to list children. - Do not use first names - Use first names + Do not list children + List children @@ -413,7 +354,7 @@ - + Detailed Descendant Report @@ -432,16 +373,6 @@ - - listc: =0/1 - - Whether to list children. - - Do not list children - List children - - - incsources: =0/1 @@ -503,12 +434,12 @@ - firstnameiop: =0/1 + listc: =0/1 - Whether to use first names instead of pronouns + Whether to list children. - Do not use first names - Use first names + Do not list children + List children @@ -522,6 +453,16 @@ + + usenick: =0/1 + + Whether to use the nick name as the first name. + + Do not use nick name + Use nick name + + + incnotes: =0/1 @@ -554,7 +495,7 @@ - + Family Group Report @@ -572,7 +513,7 @@ - + Fan Chart @@ -583,7 +524,7 @@ - + FTM Style Ancestor Report @@ -594,7 +535,7 @@ - + FTM Style Descendant Report @@ -605,7 +546,7 @@ - + Relationship Graph @@ -775,7 +716,7 @@ - + Relationship Graph @@ -945,7 +886,7 @@ - + Complete Individual Report @@ -966,7 +907,7 @@ - + Individual Summary @@ -977,7 +918,7 @@ - + Generate Web Site (deprecated) @@ -1167,6 +1108,51 @@ + + + Book Report + + + name: + + book + + + + bookname: =name + + Name of the book. MANDATORY + + + + + + Descendant Wall Chart + + + name: + + descend_chart2 + + + + singlep: =0/1 + + Whether to scale to fit on a single page. + + Do not scale to fit + Scale to fit + + + + + title: =str + + Title string for the report + Value: Whatever String You Wish + + + @@ -1184,8 +1170,6 @@ id: =ID Gramps ID of a central person. - - @@ -1227,73 +1211,6 @@ - Checkpoint the database - - - name: - - chkpoint - - - - crcmd: =str - - Custom command line for retrieval - Value: Custom command string - - - - cacmd: =str - - Custom command line for archiving - Value: Custom command string - - - - archive: =0/1 - - Whether to archive or retrieve. - - Retrieve - Archive - - - - - rcs: =0/1 - - Whether to use RCS (ignores custom commands). - - Do not use RCS - Use RCS - - - - - - - Dumps gender statistics - - - name: - - dgenstats - - - - - - Rebuild secondary indices - - - name: - - rebuild - - - - - Reorder GRAMPS IDs @@ -1304,75 +1221,7 @@ - - Generate Testcases for persons and families - - - name: - - testcasegenerator - - - - dates: =0/1 - - Whether to create test for date handling. - - Skip test - Create date tests - - - - - person_count: =int - - Number of dummy persons to generate - Value: Number of persons - - - - no_trans: =0/1 - - Wheter to use one transaction or multiple small ones - - One transaction - Multiple transactions - - - - - long_names: =0/1 - - Wheter to create short or long names - - Short names - Long names - - - - - bugs: =0/1 - - Whether to create invalid database references. - - Skip test - Create invalid Database references - - - - - persons: =0/1 - - Whether to create a bunch of dummy persons - - Dont create persons - Create dummy persons - - - - - - + Verify the database @@ -1491,6 +1340,161 @@ + + Generate Testcases for persons and families + + + name: + + testcasegenerator + + + + dates: =0/1 + + Whether to create test for date handling. + + Skip test + Create date tests + + + + + person_count: =int + + Number of dummy persons to generate + Value: Number of persons + + + + no_trans: =0/1 + + Wheter to use one transaction or multiple small ones + + One transaction + Multiple transactions + + + + + long_names: =0/1 + + Wheter to create short or long names + + Short names + Long names + + + + + bugs: =0/1 + + Whether to create invalid database references. + + Skip test + Create invalid Database references + + + + + persons: =0/1 + + Whether to create a bunch of dummy persons + + Dont create persons + Create dummy persons + + + + + add_serial: =0/1 + + Wheter to add a serial number to every text field + + No serial + Add serial number + + + + + specialchars: =0/1 + + Wheter to ass some special characters to every text field + + No special characters + Add special characters + + + + + + + Checkpoint the database + + + name: + + chkpoint + + + + crcmd: =str + + Custom command line for retrieval + Value: Custom command string + + + + cacmd: =str + + Custom command line for archiving + Value: Custom command string + + + + archive: =0/1 + + Whether to archive or retrieve. + + Retrieve + Archive + + + + + rcs: =0/1 + + Whether to use RCS (ignores custom commands). + + Do not use RCS + Use RCS + + + + + + + Rebuild secondary indices + + + name: + + rebuild + + + + + + Dumps gender statistics + + + name: + + dgenstats + + + + Generate Commandline Plugin Reference diff --git a/gramps2/doc/gramps-manual/C/usage.xml b/gramps2/doc/gramps-manual/C/usage.xml index 5d7c7f75d..d6ed44fca 100644 --- a/gramps2/doc/gramps-manual/C/usage.xml +++ b/gramps2/doc/gramps-manual/C/usage.xml @@ -4793,50 +4793,206 @@ Web Page - - - This category includes reports producing web sites based on - your data. - + The only available report in this category + is the Narrative Web Site report. It generates a + web site (that is, a set of linked web pages), for + a set of selected individuals. + + + Narrative Web Site + - Generate Web Site + Introduction - - - This report generates web pages, either for a selected - individual (active person) or a set of individuals. The - options for this report are broken down into contents, - privacy, and advanced options. The contents options - include the filter (determine the scope of the database - to consider), destination directory for the images, an - optional short ancestor tree, and a link to the index - page. Privacy options allow you to omit private - records, restrict information on living people, skip - images (either all or only those of living people), and - omit comments and text in source information. Finally, - the advanced options allow you to include the optional - &app; ID, create a GENDEX index, and specify the - extension of the resulting files. - - + + &app; 2.0.6 introduced the Narrative Web generator. + The new tool provides considerably more functionality + than the older web generator. Instead of using HTML + templates to customize the pages, CSS style sheets are used. + + + + More information is now displayed about each person, + along with information about sources, places, and media + objects. Introduction pages can be added to provide additional + information, such as family history. - Narrative Web Site + Selecting the output - + + Genealogy records can generate a lot of files. Many web + servers have a difficult time with many files in a single + directory. The Narrative Web Generator strives to keep the + number of files per directory to a managable level. To do + this, a hierarchy of directores is created. The generated + files names are not intuitive, but are unique per person. + Subsequent runs will geneate identical file names, making + it easy to replace files. + + + By default, the output files are written to the specified + directory. Because of the number of files and directories + that are created, it may be difficult to transfer the files + to an external web host. To aid in this, you may directly + create a gzip'd tar file to more easily upload the data. + This is the format that should be used if you would like + to take advantage of the free genealogy page hosting at the + GRAMPS web hosting site. + + To select the gzip'd tar file, select the Store + web pages in .tar.gz archive option. + - This report is an alternative web site generator, - producing the narrative set of web pages. It is still in - development, with the goal of producing a more complete, - better looking, and easily adjustable web site. + + Applying a filter + + + Like the previous web page generator, and most of the other + &app; reports, you can control what is included in the output + by choosing a filter. Several default filters are provided for + you, but you are free to use the Custom Filter Editor tool to + create your own. + + Any person matching this filter who is not excluded due + to the privacy rules, will be included in the output. The default + filter includes all people in the database. + - + + Applying a style sheet + + GRAMPS provides six built in style sheets for your web page. + Each of these style sheets produces a unique look for your pages. + The generated style sheet is named narrative.css. + You may edit this file if you wish to further customize your + site. + + + If you make modifications to your style sheet, you need to be aware + the regenerating the pages with the same output directory will + overwrite your changes to this file. To prevent this from happening, + make sure you choose No style sheet for subsequent + runs. + + + + Character set encoding + + + Because of GRAMPS internationalization ability, the default character + set for the HTML pages is UTF-8. This provides support for virtually + all characters. + + The Apache web server is sometimes misconfigured to override + the character set specified in an HTML page. This causes problems with + the UTF-8 character set generated by GRAMPS, distorting characters on + the screen. + + If your web server is misconfigured and you do not have priveledge + to fix the configururation, you may solve this problem by overriding the + default character set to match what your web server may be expecting. + + + + Copyright notice + + International copyright law reserves all rights to your data. + You own the data, and people must get your permission to use it. + In genealogy, however, sharing data is a common ideal. It this case, you + may wish to grant the user more rights. + + While the default for GRAMPS is to place a notice indicating that + all rights are reserved, we give you the option to place your site under + one of several of the Create Commons licenses. With a Creative Commons + license, you grant user's certain permission to use your data without + requiring them to contact you directly for permission. + + See the Creative + Commons web site for more information. + + + + Controlling page generation + + Three additional pages can be generated by the web page generator. + The Home page is a page that will display an image and a whatever text + you wish. To enable this page, choose a Media Object + from the Home Media/Note ID menu on the Page + Generation tab. If the Media Object contains an image, the image + is displayed at the top of the page. If the Media Object contains a Note, + the Note's text is used for the text of the page. A second page, the + Introduction page, works similarly. Just choose the Media Object in the + Introduction Media/Note ID menu. + + If you choose to include a contact page, the researcher information + stored in the database is displayed, along with the information specified + in the Publisher contact/Note ID menu. Please use + this page with caution, + since you may consider your contact information to be private. + + + + Privacy + + Privacy of personal information is an important issue on the web + today. &app; tries to give you control over the information that is presented. + + + &app; provides two options to control the privacy of your information. + If you select the Do not include records marked private + option, any data that is marked as private will not be displayed on the + generated site. If you select Restrict information on living people, + &app; will attempt to determine which people have the potential of still + being alive, and will omit these people from the database. Some countries + have laws that indicate that a certain number of years must pass after + someone's death before information can be published. The Years + to restrict from person's death option allows you to specifiy + how many years a person must be deceased before the information is included. + + + Please note that it is your responsibility to double check all + information in the pages for any privacy information. &app; cannot be held + responsible for any privacy issues. + + + + Adding custom code your pages + + If you are not interested in customizing your pages, you may skip + the section. + + The previous web generator allowed you to customize your pages + using HTML templates. Your data would be substituted for certain markers + in the code. + + This method proved to be too cumbersome for most users. The Narrative + Web Page Generator introduces a simpler mechanism. On the Page + Generation tab, you may specify text (including HTML code) that + will be inserted into each page, separately for the header and the + footer. + + To create this code, you need to create a Media Object marked as an + internal note. To create this, add a new Media Object in the Media View, + and select the internal note option. You may then enter your HTML code. + + + + To insert the code from the internal notes into the web pages, + select the appropriate Media Objects from the HTML user + header and HTML user footer menus. + Two div sections will be added to the pages — userheader and userfooter. + The corresponding HTML code is inserted into the HTML page surrounded by div + markers. You can customize your style sheet to provide additional formatting + and positioning information to control these sections. + diff --git a/gramps2/src/plugins/CmdRef.py b/gramps2/src/plugins/CmdRef.py index 8bc93bf20..bdd8c89e6 100644 --- a/gramps2/src/plugins/CmdRef.py +++ b/gramps2/src/plugins/CmdRef.py @@ -194,11 +194,12 @@ class CmdRef(Tool.Tool): % escape(val)) f.write(' \n') else: - f.write(' \n') - for val in oclass.options_help[arg][2]: - f.write( " %s\n" - % escape(val)) - f.write(' \n') + if oclass.options_help[arg][2]: + f.write(' \n') + for val in oclass.options_help[arg][2]: + f.write( " %s" + "\n" % escape(val)) + f.write(' \n') else: f.write(' ' 'Value: %s\n'