aboutsummaryrefslogtreecommitdiffhomepage
path: root/lib/sisu/v0/param.rb
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2008-12-13 14:23:56 -0500
committerRalph Amissah <ralph@amissah.com>2008-12-13 14:24:05 -0500
commitfb1e1bf0cb8a2202eda1ab254b01b997df60a6db (patch)
tree9f28c55c6ebdcb6161f900e0ed9589f41baa9bf2 /lib/sisu/v0/param.rb
parentmostly additional metadata fields (diff)
metadata, variable renaming (requires testing)
metadata, variable renaming (dropped use of dc_ to signify dublin core metadata as is subset of what is used and cumbersome to identify) - testing required manpage minor touch
Diffstat (limited to 'lib/sisu/v0/param.rb')
-rw-r--r--lib/sisu/v0/param.rb88
1 files changed, 44 insertions, 44 deletions
diff --git a/lib/sisu/v0/param.rb b/lib/sisu/v0/param.rb
index ec80e0dd..bcf6f97b 100644
--- a/lib/sisu/v0/param.rb
+++ b/lib/sisu/v0/param.rb
@@ -118,9 +118,9 @@ module SiSU_Param
@doc={ :lv=>[] }
@doc[:fns],@doc[:fnb],@doc[:scr_suffix]='','',''
@@publisher='SiSU scribe'
- attr_accessor :cmd,:mod,:env,:fn,:fns,:fnb,:fnn,:fnt,:fnl,:flv,:fnz,:fnstex,:ocn,:sfx_src,:sfx,:pdf,:file_type,:dir_out,:dir_tex,:dir_lout,:txt_path,:site_skin,:sisu,:sisu_version,:ruby_version,:title,:dc_title,:html_title,:subtitle,:subtitle_tex,:creator_home,:dc_creator,:author_title,:author_nationality,:authors,:authorship,:translator,:illustrator,:prepared_by,:digitized_by,:dc_subject,:dc_description,:dc_publisher,:dc_contributor,:dc_date,:dc_date_created,:dc_date_issued,:dc_date_available,:dc_date_valid,:dc_date_modified,:date_translated,:date_added_to_site,:date_scheme,:date_created_scheme,:date_issued_scheme,:date_available_scheme,:date_valid_scheme,:date_modified_scheme,:dc_type,:dc_format,:dc_identifier,:dc_source,:dc_language,:language_original,:dc_relation,:dc_coverage,:dc_rights,:keywords,:comments,:abstract,:cls_loc,:cls_dewey,:cls_pg,:cls_isbn,:papersize,:papersize_array,:toc,:lv1,:lv2,:lv3,:lv4,:lv5,:lv6,:pagenew,:pagebreak,:num_top,:toc_lev_limit,:flag_endnotes,:flag_auto_endnotes,:flag_separate_endnotes,:flag_separate_endnotes_make,:flag_auto_heading_num,:markup,:markup_instruction,:markup_version,:markup_declared,:make_bold,:make_italic,:flag_tables,:vocabulary,:doc_skin,:doc_css,:yaml,:lnk,:prefix_a,:prefix_b,:suffix,:information,:contact,:icon,:image,:ad_url,:ad_png,:ad_alt,:ad_began,:flag_promo,:promo,:ad_home,:stmp,:stmpd,:sc_filename,:sc_number,:sc_date,:sc_time,:sc_info,:yamladdr,:locale,:wc_lines,:wc_words,:wc_bytes,:file_encoding,:file_size,:user,:home,:hostname,:pwd,:firstseg,:programs,:creator_copymark,:lang,:en,:dgst,:dgst_skin,:generated,:tags,:tag_array,:concord_make,:seg_names,:seg_autoname_safe,:set_header_title,:set_heading_top,:set_heading_seg,:heading_seg_first,:heading_seg_first_flag,:base_program,:man_section,:man_name,:man_synopsis,:ec,:opt,:sem_tag,:book_idx,:topic_register,:topic_register_array,:original_publication,:original_publication_date,:original_publication_nationality,:original_publication_institution,:writing_focus
+ attr_accessor :cmd,:mod,:env,:fn,:fns,:fnb,:fnn,:fnt,:fnl,:flv,:fnz,:fnstex,:ocn,:sfx_src,:sfx,:pdf,:file_type,:dir_out,:dir_tex,:dir_lout,:txt_path,:site_skin,:sisu,:sisu_version,:ruby_version,:title,:subtitle,:full_title,:html_title,:subtitle_tex,:author_home,:author,:author_title,:author_nationality,:authors,:authorship,:translator,:illustrator,:prepared_by,:digitized_by,:subject,:description,:publisher,:contributor,:date,:date_created,:date_issued,:date_available,:date_valid,:date_modified,:date_translated,:date_added_to_site,:date_scheme,:date_created_scheme,:date_issued_scheme,:date_available_scheme,:date_valid_scheme,:date_modified_scheme,:type,:format,:identifier,:source,:language,:language_original,:relation,:coverage,:rights,:keywords,:comments,:abstract,:cls_loc,:cls_dewey,:cls_pg,:cls_isbn,:papersize,:papersize_array,:toc,:lv1,:lv2,:lv3,:lv4,:lv5,:lv6,:pagenew,:pagebreak,:num_top,:toc_lev_limit,:flag_endnotes,:flag_auto_endnotes,:flag_separate_endnotes,:flag_separate_endnotes_make,:flag_auto_heading_num,:markup,:markup_instruction,:markup_version,:markup_declared,:make_bold,:make_italic,:flag_tables,:vocabulary,:doc_skin,:doc_css,:yaml,:lnk,:prefix_a,:prefix_b,:suffix,:information,:contact,:icon,:image,:ad_url,:ad_png,:ad_alt,:ad_began,:flag_promo,:promo,:ad_home,:stmp,:stmpd,:sc_filename,:sc_number,:sc_date,:sc_time,:sc_info,:yamladdr,:locale,:wc_lines,:wc_words,:wc_bytes,:file_encoding,:file_size,:user,:home,:hostname,:pwd,:firstseg,:programs,:author_copymark,:lang,:en,:dgst,:dgst_skin,:generated,:tags,:tag_array,:concord_make,:seg_names,:seg_autoname_safe,:set_header_title,:set_heading_top,:set_heading_seg,:heading_seg_first,:heading_seg_first_flag,:base_program,:man_section,:man_name,:man_synopsis,:ec,:opt,:sem_tag,:book_idx,:topic_register,:topic_register_array,:original_publication,:original_publication_date,:original_publication_nationality,:original_publication_institution,:writing_focus
def initialize(fns_array,opt)
- @env=@fn=@fns=@fnb=@fnn=@fnt=@fnl=@flv=@fnz=@fnstex=@ocn=@sfx_src=@sfx=@pdf=@file_type=@dir_out=@dir_tex=@dir_lout=@txt_path=@flag_endnotes=@flag_auto_endnotes=@flag_separate_endnotes=@flag_separate_endnotes_make=@site_skin=@sisu=@sisu_version=@ruby_version=@title=@dc_title=@html_title=@subtitle=@subtitle_tex=@creator_home=@dc_creator=@author_title=@author_nationality=@translator=@illustrator=@prepared_by=@digitized_by=@dc_subject=@dc_description=@dc_publisher=@dc_contributor=@dc_date=@dc_date_created=@dc_date_issued=@dc_date_available=@dc_date_valid=@dc_date_modified=@date_translated=@date_added_to_site=@date_scheme=@date_created_scheme=@date_issued_scheme=@date_available_scheme=@date_valid_scheme=@date_modified_scheme=@dc_type=@dc_format=@dc_identifier=@dc_source=@dc_language=@language_original=@dc_relation=@dc_coverage=@dc_rights=@keywords=@comments=@abstract=@cls_loc=@cls_dewey=@cls_pg=@cls_isbn=@papersize=@toc=@lv1=@lv2=@lv3=@lv4=@lv5=@lv6=@pagenew=@pagebreak=@num_top=@toc_lev_limit=@flag_auto_heading_num=@make_bold=@make_italic=@flag_tables=@vocabulary=@doc_skin=@doc_css=@yaml=@lnk=@prefix_a=@prefix_b=@suffix=@information=@contact=@icon=@ad_url=@ad_png=@ad_alt=@ad_began=@promo=@ad_home=@stmp=@stmpd=@sc_filename=@sc_number=@sc_date=@sc_time=@sc_info=@yamladdr=@locale=@wc_lines=@wc_words=@wc_bytes=@file_encoding=@file_size=@firstseg=@programs=@creator_copymark=@lang=@en=@dgst=@dgst_skin=@generated=@heading_seg_first=@base_program=@man_synopsis=@topic_register=@original_publication_details=@original_publication=@original_publication_date=@original_publication_nationality=@original_publication_institution=@writing_focus=nil
+ @env=@fn=@fns=@fnb=@fnn=@fnt=@fnl=@flv=@fnz=@fnstex=@ocn=@sfx_src=@sfx=@pdf=@file_type=@dir_out=@dir_tex=@dir_lout=@txt_path=@flag_endnotes=@flag_auto_endnotes=@flag_separate_endnotes=@flag_separate_endnotes_make=@site_skin=@sisu=@sisu_version=@ruby_version=@title=@subtitle=@full_title=@html_title=@subtitle_tex=@author_home=@author=@author_title=@author_nationality=@translator=@illustrator=@prepared_by=@digitized_by=@subject=@description=@publisher=@contributor=@date=@date_created=@date_issued=@date_available=@date_valid=@date_modified=@date_translated=@date_added_to_site=@date_scheme=@date_created_scheme=@date_issued_scheme=@date_available_scheme=@date_valid_scheme=@date_modified_scheme=@type=@format=@identifier=@source=@language=@language_original=@relation=@coverage=@rights=@keywords=@comments=@abstract=@cls_loc=@cls_dewey=@cls_pg=@cls_isbn=@papersize=@toc=@lv1=@lv2=@lv3=@lv4=@lv5=@lv6=@pagenew=@pagebreak=@num_top=@toc_lev_limit=@flag_auto_heading_num=@make_bold=@make_italic=@flag_tables=@vocabulary=@doc_skin=@doc_css=@yaml=@lnk=@prefix_a=@prefix_b=@suffix=@information=@contact=@icon=@ad_url=@ad_png=@ad_alt=@ad_began=@promo=@ad_home=@stmp=@stmpd=@sc_filename=@sc_number=@sc_date=@sc_time=@sc_info=@yamladdr=@locale=@wc_lines=@wc_words=@wc_bytes=@file_encoding=@file_size=@firstseg=@programs=@author_copymark=@lang=@en=@dgst=@dgst_skin=@generated=@heading_seg_first=@base_program=@man_synopsis=@topic_register=@original_publication_details=@original_publication=@original_publication_date=@original_publication_nationality=@original_publication_institution=@writing_focus=nil
@man_section=1
@man_name='man page "name/whatis" information not provided, set in header @man: name=[whatis information]'
@data,@fns,@cmd,@mod,@opt=fns_array,opt.fns,opt.cmd,opt.mod,opt #@data used as data
@@ -189,7 +189,7 @@ module SiSU_Param
end
def extract
@user,@home,@hostname,@pwd=ENV['USER'],ENV['HOME'],ENV['HOSTNAME'],ENV['PWD']
- @programs,@wc,@dc_language,@language_original={},{},{},{}
+ @programs,@wc,@language,@language_original={},{},{},{}
@en={ :sum=>0,:mark=>0,:note=>0,:mismatch=>0 }
@prog=SiSU_Env::Info_settings.new
@sys=SiSU_Env::System_call.new
@@ -309,7 +309,7 @@ module SiSU_Param
when /^(?:@ocn:|0~ocn)\s+(.+?)$/m; @ocn=$1 #% processing
when /^(?:@title:|0~title)\s+(.+?)$/m #% metainfo DC
@title=$1.strip
- @dc_title=@title.dup
+ @full_title=@title.dup
@html_title=@title.gsub(/(<p>|<p \/>|<br>|<br \/>)/,'')
@set_header_title=true
@title.chomp!(' ')
@@ -318,11 +318,11 @@ module SiSU_Param
tell.txt_grey unless @cmd =~/q/
when /^(?:@subtitle:|0~subtitle)\s+(.+?)$/m #% metainfo
@subtitle=$1.strip
- @dc_title="#{@title} - #{@subtitle}"
+ @full_title="#{@title} - #{@subtitle}"
@subtitle_tex=@subtitle
when /^(?:@(?:creator|author)-?:|0~(?:creator|author)-?)\s+(.+?)$/ #% metainfo DC
names=name_format($1)
- @authorship=@dc_creator=names[:name_str]
+ @authorship=@author=names[:name_str]
@authors=names[:name_a_h]
when /^@(?:creator|author)\.title:\s+(.+?)$/; @author_title=$1 # Prof. Dr. etc.
when /^@(?:creator|author)\.nationality:\s+(.+?)$/; @author_nationality=$1
@@ -338,12 +338,12 @@ module SiSU_Param
when /^(?:@digitized_by:|0~digitized_by)\s+(.+?)$/m #% metainfo DC
names=name_format($1)
@digitized_by=names[:name_str]
- when /^(?:@subject:|0~subject)\s+(.+?)$/m; @dc_subject=$1 #% metainfo DC
- when /^(?:@description:|0~description)\s+(.+?)$/m; @dc_description=$1 #% metainfo DC & rss feed
+ when /^(?:@subject:|0~subject)\s+(.+?)$/m; @subject=$1 #% metainfo DC
+ when /^(?:@description:|0~description)\s+(.+?)$/m; @description=$1 #% metainfo DC & rss feed
when /^(?:@contributor:|0~contributor)\s+(.+?)$/m #% metainfo DC
names=name_format($1)
- @dc_contributor=names[:name_str]
- when /^(?:@publisher:|0~publisher)\s+(.+?)$/m; @dc_publisher=$1 #% metainfo DC
+ @contributor=names[:name_str]
+ when /^(?:@publisher:|0~publisher)\s+(.+?)$/m; @publisher=$1 #% metainfo DC
when /^@original_publication:\s+(.+?)$/m; @original_publication=$1
when /^@original_publication\.date:\s+(.+?)$/; @original_publication_date=$1
when /^@original_publication\.nationality:\s+(.+?)$/; @original_publication_nationality=$1
@@ -351,13 +351,13 @@ module SiSU_Param
when /^@writing_focus\.nationality:\s+(.+?)$/; @writing_focus=$1 # e.g. Finland (where and article on Finnish law)
when /^(?:@|0~)date.+?$/m #% metainfo DC
if para =~/(?:@date:|0~date)\s+(.+?)$/m
- @dc_date=$1.strip #% original publication date unless the substantive text is updated/modified, then date of update
- if @dc_date !~regx_date \
- and not @dc_date.empty?
- tell=SiSU_Screen::Ansi.new(@cmd,'Date Format should be','YYYY-MM-DD','please correct document','Date','field, current value:',@dc_date)
+ @date=$1.strip #% original publication date unless the substantive text is updated/modified, then date of update
+ if @date !~regx_date \
+ and not @date.empty?
+ tell=SiSU_Screen::Ansi.new(@cmd,'Date Format should be','YYYY-MM-DD','please correct document','Date','field, current value:',@date)
tell.instruct if @cmd =~/v/
end
- @date_scheme='scheme="ISO-8601"' if @dc_date =~/\d{4}-\d{2}-\d{2}/
+ @date_scheme='scheme="ISO-8601"' if @date =~/\d{4}-\d{2}-\d{2}/
end
if para =~/(?:@date\.added_to_site:|0~date\.added_to_site)\s+(.+?)$/m
@date_added_to_site=$1.strip
@@ -375,7 +375,7 @@ module SiSU_Param
tell=SiSU_Screen::Ansi.new(@cmd,'Date Format should be','YYYY-MM-DD','please correct document','Date','field, current value:',date)
tell.instruct if @cmd =~/v/
end
- @dc_date_created=date
+ @date_created=date
@date_created_scheme='scheme="ISO-8601"' if date =~/\d{4}-\d{2}-\d{2}/
end
if para =~/(?:@date\.issued:|0~date\.issued)\s*(.+?)$/m
@@ -385,7 +385,7 @@ module SiSU_Param
tell=SiSU_Screen::Ansi.new(@cmd,'Date Format should be','YYYY-MM-DD','please correct document','Date','field, current value:',date)
tell.instruct if @cmd =~/v/
end
- @dc_date_issued=date
+ @date_issued=date
@date_issued_scheme='scheme="ISO-8601"' if date =~/\d{4}-\d{2}-\d{2}/
end
if para =~/(?:@date\.available:|0~date\.available)\s*(.+?)$/m
@@ -395,7 +395,7 @@ module SiSU_Param
tell=SiSU_Screen::Ansi.new(@cmd,'Date Format should be','YYYY-MM-DD','please correct document','Date','field, current value:',date)
tell.instruct if @cmd =~/v/
end
- @dc_date_available=date
+ @date_available=date
@date_available_scheme='scheme="ISO-8601"' if date =~/\d{4}-\d{2}-\d{2}/
end
if para =~/^(?:@date\.valid:|0~date\.valid)\s*(.+?)$/m
@@ -405,7 +405,7 @@ module SiSU_Param
tell=SiSU_Screen::Ansi.new(@cmd,'Date Format should be','YYYY-MM-DD','please correct document','Date','field, current value:',date)
tell.instruct if @cmd =~/v/
end
- @dc_date_valid=date
+ @date_valid=date
@date_valid_scheme='scheme="ISO-8601"' if date =~/\d{4}-\d{2}-\d{2}/
end
if para =~/^(?:@date\.modified:|0~date\.modified)\s*(.+?)$/m #% of interest rss feed & sitemap
@@ -415,7 +415,7 @@ module SiSU_Param
tell=SiSU_Screen::Ansi.new(@cmd,'Date Format should be','YYYY-MM-DD','please correct document','Date','field, current value:',date)
tell.instruct if @cmd =~/v/
end
- @dc_date_modified=date
+ @date_modified=date
@date_modified_scheme='scheme="ISO-8601"' if date =~/\d{4}-\d{2}-\d{2}/
end
if para =~/^(?:@date\.translated:|0~date\.translated)\s*(.+?)$/m
@@ -428,22 +428,22 @@ module SiSU_Param
@date_translated=date
@date_translated_scheme='scheme="ISO-8601"' if date =~/\d{4}-\d{2}-\d{2}/
end
- when /^(?:@type:|0~type)\s+(.+?)$/m; @dc_type=$1 #% metainfo DC
- when /^(?:@format:|0~format)\s+(.+?)$/m; @dc_format=$1 #% metainfo DC
- #when /^(?:@identifier:|0~identifier)\s+(.+?)$/m; @dc_identifier=$1 #% metainfo DC
- when /^(?:@source:|0~source)\s+(.+?)$/m; @dc_source=$1 #% metainfo DC
+ when /^(?:@type:|0~type)\s+(.+?)$/m; @type=$1 #% metainfo DC
+ when /^(?:@format:|0~format)\s+(.+?)$/m; @format=$1 #% metainfo DC
+ #when /^(?:@identifier:|0~identifier)\s+(.+?)$/m; @identifier=$1 #% metainfo DC
+ when /^(?:@source:|0~source)\s+(.+?)$/m; @source=$1 #% metainfo DC
when /^(?:@language(?:\.document)?:|0~language(?:\.document)?)\s+(.+?)$/m #% metainfo DC
x=$1.strip
lang=SiSU_Env::Standardise_language.new(x.dup)
- @dc_language[:code]=lang.code
- @dc_language[:name]=lang.title
+ @language[:code]=lang.code
+ @language[:name]=lang.title
when /^(?:@language\.original:|0~language\.original)\s+(.+?)$/m #% metainfo DC
x=$1.strip
lang=SiSU_Env::Standardise_language.new(x.dup)
@language_original[:name]=lang.title
- when /^(?:@relation:|0~relation)\s+(.+?)$/m; @dc_relation=$1 #% metainfo DC
- when /^(?:@coverage:|0~coverage)\s+(.+?)$/m; @dc_coverage=$1 #% metainfo DC
- when /^(?:@rights:|0~rights)\s+(.+?)$/m; @dc_rights=$1.gsub(/<(?:\/\s*)?br(?:\s*\/)?>/,Mx[:br_line]) #% metainfo DC copyright, public domain, copyleft, creative commons, etc.
+ when /^(?:@relation:|0~relation)\s+(.+?)$/m; @relation=$1 #% metainfo DC
+ when /^(?:@coverage:|0~coverage)\s+(.+?)$/m; @coverage=$1 #% metainfo DC
+ when /^(?:@rights:|0~rights)\s+(.+?)$/m; @rights=$1.gsub(/<(?:\/\s*)?br(?:\s*\/)?>/,Mx[:br_line]) #% metainfo DC copyright, public domain, copyleft, creative commons, etc.
when /^(?:@papersize:|0~papersize)\s+(.+?)$/m #% metainfo DC
l=$1
if @mod.inspect !~/--papersize[=-]\S+/
@@ -736,11 +736,11 @@ module SiSU_Param
@man_synopsis.gsub!(/\n/,"\n.BR\n")
@man_synopsis.gsub!(/\A/,"\n.SH SYNOPSIS\n")
end
- unless @dc_rights
- if @dc_creator
- @dc_rights ||=if @dc_date =~/([12][890]\d{2})/ #matches years 1800 through 20\d\d 2004w19
- "Copyright (C) #{$1} #@dc_creator"
- else 'Copyright (C)' + @dc_creator
+ unless @rights
+ if @author
+ @rights ||=if @date =~/([12][890]\d{2})/ #matches years 1800 through 20\d\d 2004w19
+ "Copyright (C) #{$1} #@author"
+ else 'Copyright (C)' + @author
end
end
end
@@ -793,17 +793,17 @@ module SiSU_Param
end
end
end
- @dc_publisher ||= "#@@publisher (this copy)"
+ @publisher ||= "#@@publisher (this copy)"
fn_set_lang=SiSU_Env::Standardise_language.new.file_to_language(@fns)
- unless @dc_language[:code] \
- and @dc_language[:name]
+ unless @language[:code] \
+ and @language[:name]
lang=@env.i18n.language #default language settings for directory by name, or in sysrc.yml
- @dc_language[:code] ||= lang.code
- @dc_language[:name] ||= lang.title
+ @language[:code] ||= lang.code
+ @language[:name] ||= lang.title
end
unless fn_set_lang[:d]==true #decide, naming convention overrides other settings, within document, etc.
- @dc_language[:code]=fn_set_lang[:c]
- @dc_language[:name]=fn_set_lang[:l]
+ @language[:code]=fn_set_lang[:c]
+ @language[:name]=fn_set_lang[:l]
end
@fnl=@env.i18n.lang_filename(fn_set_lang[:c])
@flv.each do |l|
@@ -817,7 +817,7 @@ module SiSU_Param
end if @flv
@lang.uniq!
@fn=SiSU_Env::Env_call.new(@fns).lang(fn_set_lang[:c])
- @dc_identifier="#{@env.url.root}/#@fnb/#{@fn[:toc]}" #DC note constructed dc identifier
+ @identifier="#{@env.url.root}/#@fnb/#{@fn[:toc]}" #DC note constructed dc identifier
if @en[:note] > 0 \
and @en[:sum] > 0
if @en[:sum] > 0
@@ -836,8 +836,8 @@ module SiSU_Param
tell=SiSU_Screen::Ansi.new(@cmd,'Document Title Missing','please provide it')
tell.warn if @cmd =~/v/
end
- if @dc_creator !~/[\S]/
- tell=SiSU_Screen::Ansi.new(@cmd,'Document Creator/Author Missing','please provide it')
+ if @author !~/[\S]/
+ tell=SiSU_Screen::Ansi.new(@cmd,'Document Author/Creator Missing','please provide it')
tell.warn if @cmd =~/v/
end
# Elementary Document Structure Analysis - adds complexity may remove - need to develop - appears to work, proof of concept